自定义参数解析器，减少10%的代码

你的名字 2024-03-23 15:39 81阅读 0赞

## 前言 ##

springMvc中提供了很多好用的参数绑定的方式方法，那枚举呢？或者参数的值是一个json字符串的时候？你是怎么处理的？下面我就给jym分享一下我的处理方式。

## 枚举 ##

普通的枚举类型，比如单列值的那种：one ，two... 。这种事不需要特殊处理的，我们是可以直接接收值并绑定数据的。

要是下面这种枚举类型呢？而且我们的参数传递的是：0，1这种数字，方法参数是枚举类型。spring还能帮我们自动绑定参数嘛？

public enum StatusEnum {
        online(1),
        offline(0);
    
        private Integer value;
    
        StatusEnum(Integer value) {
            this.value = value;
        }
    
        public Integer getValue() {
            return value;
        }
    }
    复制代码

这时候spring就无法自动帮我们绑定参数了，报如下错误：

![format_png][]

### 实现方式 ###

*  通过定时枚举参数注解来标记参数：这是一个枚举类型的参数。
 *  通过自定义参数解析器来分析枚举参数注解，来实现参数的绑定。

定义注解

@Target({ElementType.PARAMETER})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface EnumParam {
        String value() default "";
        /**
         * 赋值调用方法
         * 如果为空，默认调用name()方法
         * 该方法必须是一个不含参数的方法，否则将会调用失败
         *
         * @return
         */
        String valueMethod() default "";
    }
    复制代码

1.  value() : value用于绑定请求参数和方法参数名一致时的对应关系。比如user?statusNo=1 。 方法的参数写法如下：getUser(@EnumParam(value="statusNo") int status) 或者 getUser(@EnumParam() int statusNo)
2.  valueMethod() : 赋值时调用枚举中的方法。

1.  1.  如果该属性不传值则默认调用枚举类默认提供的 “valueOf()” 方法。
    2.  如果自定义一个方法，该方法必须是一个不含参数的方法，否则将会调用失败。比如上述示例枚举 `StatusEnum的getValue()`方法。

定义枚举参数解析器

核心代码：

// 1
    public class EnumParamArgumentResolver implements HandlerMethodArgumentResolver {
        @Override
        public boolean supportsParameter(MethodParameter parameter) {
            return parameter.hasParameterAnnotation(EnumParam.class);
        }
    
        @Override
        public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
            // 2 
            EnumParam annotation = parameter.getParameterAnnotation(EnumParam.class);
            Object object = null;
            if (annotation != null) {
                String parameterName = annotation.value();
                // 3
                if (!StringUtils.hasText(parameterName)) {
                    parameterName = annotation.name();
                }
                if (!StringUtils.hasText(parameterName)) {
                    parameterName = parameter.getParameterName();
                }
    
                String value = webRequest.getParameter(parameterName);
    
                if (StringUtils.hasText(value)) {
                    // 4 
                    Class<?> objectType = parameter.getParameterType();
                    String method = Objects.equals(annotation.valueMethod(), "") ? "valueOf" : annotation.valueMethod();
                    Object[] enumConstants = objectType.getEnumConstants();
                    // 如果方法没了就 抛出异常
                    Method declaredMethod = objectType.getDeclaredMethod(method);
                    try {
                        for (Object enumConstant : enumConstants) {
                            // 5
                            Object invoke = method.equals("valueOf") ? declaredMethod.invoke(enumConstant, enumConstant.toString()) : declaredMethod.invoke(enumConstant);
                            if (invoke != null) {
                                if (Convert.toStr(invoke).equals(Convert.toStr(value))) {
                                    object = enumConstant;
                                    break;
                                }
                            }
                        }
                    } catch (Exception e) {
                        log.error("参数enum转换失败:{}.{}[{}]", parameter.getContainingClass().getName(), parameter.getMethod().getName(), parameterName);
                        object = null;
                    }
                }
                mavContainer.addAttribute(parameterName, object);
            }
            return object;
        }
    }
    复制代码

1.  枚举参数解析器（EnumParamArgumentResolver）实现 spring mvc的扩展接口HandlerMethodArgumentResolver。
2.  从参数中获取是否标记了 EnumParam 注解，如果是则进行解析。
3.  处理 EnumParam.value() 的值并进行赋值给parameterName。
4.  通过返回的方式拿到需要执行的方法和目标枚举类的值。
5.  通过循环枚举的值然后比较。如果匹配则立即跳出循环并mavContainer.addAttribute(parameterName, object);然后返回。

以上就是实现枚举参数解析器的全部步骤。

#### 示例 ####

方法示例：

![format_png 1][]

请求示例：

![format_png 2][]

## json字符串 ##

我们有时候可能会遇到这种请求：

`localhost:8088/prt/jsonParams?user={"age":12,"id":"1","name":"凹凸曼"}` 那么这种我们可能一般都是使用String接收，然后在调用转JSON的API进行处理。可是这种代码每个方法都去写的话，太不优雅了。毕竟：「**温柔永不落伍，** **优雅永不过时 」** **。**

### 实现方式 ###

*  通过定时JSON参数注解来标记参数：这是一个JSON字符串的参数。
 *  通过自定义参数解析器来分析JSON字符串参数注解，来实现参数和对象属性的绑定。

定义注解

@Target({ElementType.PARAMETER})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface JsonParam {
        String value() default ""
    
        Class<?> objectType() default JsonParam.class;
    }
    复制代码

1.  value() : value用于绑定请求参数和方法参数名一致时的对应关系。和 EnumParam中的value定义差不多。
2.  objectType() : 当参数是数组对象时，赋值属性。

定义Json参数解析器

核心代码：

public class JsonParamArgumentResolver implements HandlerMethodArgumentResolver {
        @Override
        public boolean supportsParameter(MethodParameter parameter) {
            return parameter.hasParameterAnnotation( JsonParam.class );
        }
    
        @Override
        public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
            JsonParam annotation = parameter.getParameterAnnotation( JsonParam.class );
            Object object = null;
            if (annotation != null) {
                String parameterName = annotation.value();
                if (StringUtils.isBlank( parameterName )) {
                    parameterName = annotation.name();
                }
    
                if (StringUtils.isBlank( parameterName )) {
                    parameterName = parameter.getParameterName();
                }
    
                String value = webRequest.getParameter( parameterName );
                if (StringUtils.isNotBlank( value )) {
                    // 2
                    Class<?> objectType = annotation.objectType();
                    try {
                        if (objectType != JsonParam.class) {
                            object = JSON.parseArray( value, objectType );
                        } else {
                            object = JSON.parseObject( value, parameter.getParameterType() );
                        }
                    } catch (Exception e) {
                        LoggerFactory.getLogger( JsonParamArgumentResolver.class )
                                .error( "参数Json转换失败:" + parameter.getContainingClass().getName() + "." + parameter.getMethod().getName() + "[" + parameterName + "]" );
                        object = null;
                    }
                }
                //this.validate( parameter, mavContainer, object, parameterName );
                mavContainer.addAttribute( parameterName, object );
            }
            return object;
        }
    }
    复制代码

1.  上述步骤的大部分逻辑和 枚举参数解析器 大体一致。
2.  步骤2是判断objectType是否是JsonParam类型，如果是则是对象类型；如果不是JsonParam，这是数组对象类型。

以上就是实现Json参数解析器的全部步骤。

#### 示例 ####

示例1

普通对象方法示例：

![format_png 3][]

请求示例：

![format_png 4][]

示例2

数组对象方法示例：

![format_png 5][]

请求示例：

![format_png 6][]

## SpringMvc自带解析器 ##

### 普通参数绑定&@RequestParam ###

一般我们普通的参数我们无需加任何额外的注解标记，spring既可以给我们自定绑定参数。

这种，当我们的请求参数与方法参数不一致时可以使用@RequestParam

如下：

![format_png 7][]

![format_png 8][]

### @PathVariable ###

在Controller方法的参数前面添加@PathVariable注解，将路径参数的值绑定到对应的参数上。

如下：

![format_png 9][]

![format_png 10][]

### @RequestBody ###

在Controller方法的参数前面添加@RequestBody注解，将请求体的值绑定到对应的参数上 。 **注意这种模式不支持：** `Content-Type: application/x-www-form-urlencoded`**或** `Content-Type: application/x-www-form`**的请求。**

![format_png 11][]

![format_png 12][]

### @ModelAttribute ###

在Controller方法的参数前面添加@ModelAttribute注解，将表单参数的值绑定到对应的参数上。**同上这种模式不支持** `Content-Type: application/json`**的请求。**

![format_png 13][]

![format_png 14][]

## 附录 ##

### 问题1 ###

springBoot+tomcat报错：*Invalid character found in the request target \[...\]. The valid characters are defined in RFC 7230 and RFC 3986*

原因是：SpringBoot 2.0.0 以上都采用内置tomcat8.0以上版本，而tomcat8.0以上版本遵从RFC规范添加了对Url的特殊字符的限制，url中只允许包含英文字母(a-zA-Z)、数字(0-9)、-\_.~四个特殊字符以及保留字符( ! \* ’ ( ) ; : @ & = + $ , / ? \# \[ \] ) (26\*2+10+4+18=84)这84个字符,请求中出现了\{\}大括号或者\[\],所以tomcat报错。

处理办法：在application.yml配置文件中如下配置：

server:
    	tomcat:
        relaxed-path-chars: ['|','{','}','[',']']
        relaxed-query-chars: ['|','{','}','[',']']

[format_png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/0d0e08aaec66483db86943f2194ff36d.png
[format_png 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/486c343320594b12b1933fdd8e8ba33d.png
[format_png 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/f12e2154c00f42eab9c41f6dcaaf32c9.png
[format_png 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/961071d841654e01becc4db7bde068d5.png
[format_png 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/e16a7d64c7a74bab9f508407138d3cfb.png
[format_png 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/fad0e6d25529457cbd7afa8f8083fe18.png
[format_png 6]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/3694e024dd8e48638c7fc28c3dcea5ca.png
[format_png 7]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/a7c0bfb340734e3c9281ac056e97b6b5.png
[format_png 8]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/19630115d6e44bc2b9b88a5e6d2ed49f.png
[format_png 9]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/90bd85fecd2945c2b2bf018f58056ab7.png
[format_png 10]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/194c31af743640e29a4392ea7193ecb7.png
[format_png 11]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/19cbd5f8770242fe99220e41b4b07681.png
[format_png 12]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/037b638341d24d6791e01a7a61dab73a.png
[format_png 13]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/5100acc6863b400bbdcf19e0b983c74a.png
[format_png 14]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/23771343c4a94fbb92731703223a58dd.png