需求：

对于Spring Boot由于在不同接口时，往往使用的server层的方法是一样的，但是对于不同的接口需要返回的字段却不相同。还有在数据库中有一些敏感字段也是不能返回给前端的，所以需要能在接口处自定义返回JSON属性。

解决方法

  1. 可以在写sql语句时，不查询该字段的内容，但是这个方法会减少代码的复用性，加大工作量。
  2. 可以使用Spring Boot自带的注解@JsonIgnore。将@JsonIgnore写在实体类的属性属性上，当你在返回改该类（或者包含该类的对象）时，Spring Boot会自动忽略序列化这个字段。也可以使用@jsonview注解，在实体类中设置特定的视图（图中就是期望返回的属性），然后在接口处设置返回的视图类型（只会返回期望的属性）。
    使用方法（从网上摘的代码，没有试过）：
  • 实体类
    大概的意思就是：首先声明视图UserSimpleView，然后在属性或者属性的get方法加上@JsonView(UserSimpleView.class)注释。而UserDetailView视图继承UserSimpleView视图应该是UserDetailView会包含UserSimpleView所含有的属性。
import com.fasterxml.jackson.annotation.JsonView;

public class User {

    public interface UserSimpleView {};
    public interface UserDetailView extends UserSimpleView {};

    private String username;
    private  String password;
    
    @JsonView(UserSimpleView.class)
    public String getUsername (){
        return username;
    }

    public void setUsername (String username){
        this.username = username;
    }
    @JsonView(UserDetailView.class)
    public String getPassword (){
        return password;
    }

    public void setPassword (String password){
        this.password = password;
    }

    @Override
    public String toString (){
        return "User{"+"username='"+username+'\''+",password='"+password+'\''+'}';
    }
}
  • Controller
    接口中只要在接口处添加上@JsonView(User.UserSimpleView.class)的注解就可以啦。
@RequestMapping(value = "/UserSimpleView")
    @JsonView(User.UserSimpleView.class)
    public List<User> query(UserQueryCondition userQueryCondition){
        System.out.println(pageable.getPageNumber());
        System.out.println(pageable.getSort());
        System.out.println(pageable.getPageSize());
        System.out.println(userQueryCondition.toString());
        List<User> users=new ArrayList<>();
        users.add(new User());
        users.add(new User());
        users.add(new User());
        return  users;
    }
    @RequestMapping("/UserDetailView")
    @JsonView(User.UserDetailView.class)
    public User getInfo(@PathVariable String id){
        User user=new User();
        user.setUsername("knyel");
        System.out.println(user);
        return user;
    }

其实也挺麻烦的不是吗?？

  1. 使用阿里提供的fastjson，能够在接口返回时选择过滤的属性，但是需要在Spring中配置FastJsonViewResponseBodyAdvice，使用起来太麻烦，而且本人一直没有找到具体的配置说明，只有一份在SpringMVC下使用的测试用例。这里直接给出GitHub的测试用例地址，代码我就不贴了同学们自己看吧。
  2. 偶然在网上找到了Liuyis/jsonfilter写的JSON过滤工具，这个工具主要是在fastjson的基础上封装了一层，使得能够在每个接口上利用注解去过滤json属性非常方便（也可能背后蕴藏着巨大的问题?）

JsonFilter使用方法

具体的使用方法参见作者的GitHub或者博客，我在这块就不多赘述了。但是我还要加上几点注意的地方。

  • 注意：
  1. 主要的使用步骤就是三点，第一在maven中将第三方的包加入管理（或者手动添加包），第二在Spring Boot中程序主入口中将第三方的包添加至扫描中，第三在接口上添加注释。
    如：其中"com.liuyis.jsonfilter"便是此工具的包。
@SpringBootApplication(scanBasePackages={"demo","com.liuyis.jsonfilter"})
public class DataLakeDemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DataLakeDemoApplication.class, args);
    }

}
  1. 作者提供的版本的依赖是Spring Boot 1.5的版本。而我当前使用是Spring Boot 2.1的版本，直接使用会提示某些包找不到。所以我重新修改源码中的依赖版本，然后使用maven工具重新对修改后的代码打包，打包命令mvn clean install -Dmaven.test.skip=true。