java 启动参数 别名,Spring boot 参数别名处理

背景

处理老系统时，前端请求的参数使用的蟒蛇式(如：create_time),而后端接收使用的是驼峰式(如createTime)。我们想自动进行参数转换。

Spring 提供的能力

@RequestParam：如果参数较少可以使用这种类型的处理方式。

如果使用GET方式获取较多的参数，我们一般将参数封装为实体，则上述方法就不能使用了。

解决方案

通过自定义注解和参数映射进行处理。

注解

@Target(ElementType.FIELD)

@Retention(RetentionPolicy.RUNTIME)

public @interface RequestParamAlias {

/**

* 参数名(别名)列表

*/

String[] value();

}

使用demo

public class Param {

@RequestParamAlias("asc_column")

private String ascColumn;

@RequestParamAlias("asc_flag")

private boolean ascFlag;

}

处理类

/**

*

*/

public class AliasDataBinder extends ExtendedServletRequestDataBinder {

public AliasDataBinder(Object target, String objectName) {

super(target, objectName);

}

/**

* 复写addBindValues方法

* @param mpvs 这里面存的就是请求参数的key-value对

* @param request 请求本身, 这里没有用到

*/

@Override

protected void addBindValues(MutablePropertyValues mpvs, ServletRequest request) {

super.addBindValues(mpvs, request);

// 处理要绑定参数的对象

Class> targetClass = getTarget().getClass();

// 获取对象的所有字段(拿到Test类的字段)

Field[] fields = targetClass.getDeclaredFields();

// 处理所有字段

for (Field field : fields) {

// 原始字段上的注解

RequestParamAlias valueFromAnnotation = field.getAnnotation(RequestParamAlias.class);

// 若参数中包含原始字段或者字段没有别名注解, 则跳过该字段

if (mpvs.contains(field.getName()) || valueFromAnnotation == null) {

continue;

}

// 参数中没有原始字段且字段上有别名注解, 则依次取别名列表中的别名, 在参数中最先找到的别名的值赋值给原始字段

for (String alias : valueFromAnnotation.value()) {

// 若参数中包含该别名, 则把别名的值赋值给原始字段

if (mpvs.contains(alias)) {

// 给原始字段赋值

mpvs.add(field.getName(), mpvs.getPropertyValue(alias).getValue());

// 跳出循环防止取其它别名

break;

}

}

}

}

}

public class AliasModelAttributeMethodProcessor extends ServletModelAttributeMethodProcessor {

private ApplicationContext applicationContext;

public AliasModelAttributeMethodProcessor(ApplicationContext context) {

super(true);

this.applicationContext = context;

}

@Override

protected void bindRequestParameters(WebDataBinder binder, NativeWebRequest request) {

AliasDataBinder aliasBinder = new AliasDataBinder(binder.getTarget(), binder.getObjectName());

RequestMappingHandlerAdapter requestMappingHandlerAdapter = applicationContext.getBean(RequestMappingHandlerAdapter.class);

requestMappingHandlerAdapter.getWebBindingInitializer().initBinder(aliasBinder);

aliasBinder.bind(request.getNativeRequest(ServletRequest.class));

}

}

注入到Spring

@Configuration

public class WebMvcConfig implements ApplicationContextAware {

@Autowired

private RequestMappingHandlerAdapter adapter;

private ApplicationContext applicationContext = null;

@Override

public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {

this.applicationContext = applicationContext;

}

@PostConstruct

protected void injectSelfMethodArgumentResolver() {

List argumentResolvers = new ArrayList<>();

argumentResolvers.add(new AliasModelAttributeMethodProcessor(this.applicationContext));

argumentResolvers.addAll(adapter.getArgumentResolvers());

adapter.setArgumentResolvers(argumentResolvers);

}

}

参考