利用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

這也算是一種數據列權限控制的一種解決方案吧。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章