利用Jackson的JsonFilter來實現動態過濾資料列（資料列權

利用Jackson的JsonFilter來實現動態過濾資料列。

也就是說，同一個實體，你配置了不同的@JsonFilter,透過Jackson展現的結果可以是不一樣的。

舉個例子：

@lombok.Datapublic class User{
  String username;
  String password;
  Integer age;
  String gender;
  String blog;
}

預設不做任何配置的話，透過Jackson序列化出來的結果是：

{
  "username" : "tomcatandjerry",
  "password" : "123456",
  "age" : 36,
  "gender" : "男",
  "blog" : "http://www.cnblogs.com/tomcatandjerry/"
}

 

可是password不應該要展示，方法有多種：

方法1：在不想序列化的欄位上加註解JsonProperty：

@JsonProperty(access = JsonProperty.Access.WRITE_ONLY)//Jackson
@JSONField(serialize = false)//fastjson
String password;

方法2：

 2.1在User類上面加註解JsonFilter:

@JsonFilter("non-password")
public class User {
  ...
}

 2.2 配置FilterProvider

測試方法&配置如下：

public class JsonFilterTest {    private ObjectMapper setupJsonFilter(){
        ObjectMapper mapper = new ObjectMapper();
        String[] beanProperties = new String[]{"password"};
        String nonPasswordFilterName = "non-password";//需要跟User類上的註解@JsonFilter("non-password")裡面的一致
        FilterProvider filterProvider = new SimpleFilterProvider()
                .addFilter(nonPasswordFilterName, SimpleBeanPropertyFilter.serializeAllExcept(beanProperties));                //serializeAllExcept 表示序列化全部，除了指定欄位                //filterOutAllExcept 表示過濾掉全部，除了指定的欄位        mapper.setFilterProvider(filterProvider);        return mapper;
    }

    @Test    public void testJsonFilter() throws JsonProcessingException {
        User user = new User();
        user.setUsername("tomcatandjerry");
        user.setPassword("123456");
        user.setAge(36);
        user.setGender("男");    
        System.out.println(setupJsonFilter().writeValueAsString(user));
    }
}

列印測試結果：

{
  "username" : "tomcatandjerry",
  "age" : 36,
  "gender" : "男",
  "blog" : "http://www.cnblogs.com/tomcatandjerry/"
}

小結：

看上去似乎使用@JsonProperty更簡單。
但是當有一堆欄位需要配置，而且整個專案都需要統一處理的時候，後者@JsonFilter是一個不錯的選擇。

 

擴充套件：

同一個API，如果我想不同的人看到不一樣的結果呢？
比如同一個使用者API，有的展示username+age, 有的展示username+gender等

這個時候JsonFilter就非常適合了。

有人可能會問：不對啊？一個物件只能配置一個JsonFilter，怎麼動態切換不同的Filter？
對的，一個物件只能配置一個JsonFilter，但只要稍加修改，就能實現？？

思路：
既然一個物件只能配置一個JsonFilter，那麼靠一個物件來動態展示不同的屬性是不可能的。
我們可以多寫幾個物件，都繼承User物件，不同的子類裡面使用不同的JsonFilter

@JsonFilter("normal-user")public class UserNormal extends User{ //空class，裡面沒有任何屬性}

@JsonFilter("admin")public class UserAdmin extends User{ //空class，裡面沒有任何屬性}

利用Spring的切點，根據當前使用者的角色，替換返回值為不同的子類

原本：public class UserService{  
  public User get(String id){
    
  }
}

利用切點(可以自定義註解，加到方法上，切在註解上面)，替換返回的物件為子類：

具體需要用到的：
1) 掃描並快取子類
2) @Aspect切點，@Around(value="比如：自定義註解")
3) 利用反射，建立出子類物件，BeanUtils.copyProperties

這樣看似呼叫userService.get("id")返回的是User物件，其實可能已經替換成某一個子類了。

在ObjectMapper配置多個Filter，就實現了動態展示不同屬性，且對開發人員透明。

小結：

優點: 對開發透明
缺點：一個物件需要寫多個子類，雖然是空class

這也算是一種資料列許可權控制的一種解決方案吧。