springboot返回内容特殊符号处理

需求说明

1. 根据需求部分字段内容为正则表达式,包含特殊符号’<’,’>等,导致html解析错误,字段显示错误或显示部分。
2. 对特殊字段需要过滤,如:用户密码等不应该返回到前端

解决方案

1. 可以在单个方法中对数据进行处理,但是这样会增加代码复杂度,具有侵入性
2. 使用切面思想,对返回json进行统一处理

代码

1. 创建注解

package com.pactera.ai.manage.commons.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.web.bind.annotation.ResponseBody;

/**
* @user : Administrator

* @desc : 处理responseBody 只能在@ResponseBody 方法上使用

* @date : 2019年2月15日 
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@ResponseBody
public @interface SerializedField {

	/**
     * 需要去除的字段
     * @return
     */
    String[] excludes() default {};
    
    /**
     * 数据是否需要加密
     * @return
     */
    boolean encode() default false;
    
    /**
     * 需要替换特殊字符的字段 特殊字段包括< > 等
     * @return 
     * */
    String[] characters() default {};
}

2. 创建类实现ResponseBodyAdvice接口,对返回参数进行处理。ResponseBodyAdvice可以指定参数类型,从而实现对不对返回类型数据进行不同处理,这里使用ResponseBodyAdvice对所有类型进行统一处理。

package com.pactera.ai.manage.commons.web;

import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import org.apache.commons.lang3.StringUtils;
import org.springframework.core.MethodParameter;
import org.springframework.core.annotation.Order;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

import com.pactera.ai.manage.commons.annotation.SerializedField;
import com.pactera.ai.manage.commons.util.LayerData;
import com.pactera.ai.manage.commons.util.RestResponse;

import lombok.Data;
import lombok.extern.slf4j.Slf4j;

/**
 * @user : Administrator
 * 
 * @desc : 处理返回json
 * 
 * @date : 2019年2月15日
 */
@Slf4j
@Order(1)
@ControllerAdvice(basePackages = "com.pactera.ai.manage.controller")
public class CustomResponseBodyAdvice implements ResponseBodyAdvice