SpringBoot中通过自定义Jackson注解实现接口返回数据脱敏

**SpringBoot 中通过自定义 Jackson 注解实现接口返回数据脱敏**

在 SpringBoot 应用中，使用 RESTful 接口返回数据是非常常见的需求。然而，在某些情况下，我们可能需要对返回的数据进行脱敏，以保护用户隐私或遮蔽敏感信息。在本文中，我们将介绍如何通过自定义 Jackson 注解实现接口返回数据脱敏。

**问题背景**

在实际开发过程中，可能会遇到以下场景：

* 需要对用户的个人信息（如手机号、邮箱等）进行脱敏，以保护用户隐私。
* 需要遮蔽敏感信息（如密码、验证码等），以防止泄露。

**解决方案**

为了实现接口返回数据脱敏，我们可以通过自定义 Jackson 注解来实现。Jackson 是一个非常流行的 JSON 序列化库，用于 Java 应用中。

首先，我们需要在项目中添加 Jackson 的依赖：

xml<dependency>
 <groupId>com.fasterxml.jackson.core</groupId>
 <artifactId>jackson-databind</artifactId>
 <version>2.12.3</version>
</dependency>

javaimport com.fasterxml.jackson.annotation.JsonFilter;

public @interface Desensitized {
}

javaimport com.fasterxml.jackson.databind.ser.FilterProvider;
import com.fasterxml.jackson.databind.ser.impl.SimpleBeanPropertyFilter;
import com.fasterxml.jackson.databind.ser.impl.SimpleFilterProvider;

public class DesensitizeFilter extends SimpleBeanPropertyFilter {

 @Override public Object filter(Object graph, java.util.Set set) {
 if (graph instanceof Map) {
 Map map = (Map) graph;
 for (Iterator iterator = map.entrySet().iterator(); iterator.hasNext();) {
 Entry entry = (Entry) iterator.next();
 String key = entry.getKey();
 if (key.equals("password") || key.equals("phone")) {
 iterator.remove();
 }
 }
 } else if (graph instanceof List) {
 List list = (List) graph;
 for (Iterator iterator = list.iterator(); iterator.hasNext();) {
 Object obj = iterator.next();
 if (obj instanceof Map) {
 Map map = (Map) obj;
 for (Iterator iterator1 = map.entrySet().iterator(); iterator1.hasNext();) {
 Entry entry = (Entry) iterator1.next();
 String key = entry.getKey();
 if (key.equals("password") || key.equals("phone")) {
 iterator1.remove();
 }
 }
 } else if (obj instanceof List) {
 List list1 = (List) obj;
 for (Iterator iterator2 = list1.iterator(); iterator2.hasNext();) {
 Object obj1 = iterator2.next();
 if (obj1 instanceof Map) {
 Map map1 = (Map) obj1;
 for (Iterator iterator3 = map1.entrySet().iterator(); iterator3.hasNext();) {
 Entry entry1 = (Entry) iterator3.next();
 String key1 = entry1.getKey();
 if (key1.equals("password") || key1.equals("phone")) {
 iterator3.remove();
 }
 }
 }
 }
 }
 }
 }
 return graph;
 }

 @Override public java.util.Set getFilterIds() {
 return null;
 }
}

java@Beanpublic FilterProvider filterProvider() {
 SimpleBeanPropertyFilter filter = new DesensitizeFilter();
 return new SimpleFilterProvider().addFilter("desensitize", filter);
}

@Beanpublic ObjectMapper objectMapper() {
 ObjectMapper mapper = new ObjectMapper();
 mapper.setFilters(filterProvider());
 return mapper;
}

java@RestController@RequestMapping("/api")
public class UserController {

 @GetMapping("/user/{id}")
 public User getUser(@PathVariable Long id) {
 // ...
 }
}

javapublic class User {
 private Long id;
 @Desensitized private String password;
 @Desensitized private String phone;
 // ...
}