BasicRESTCmdlet使用说明

最新推荐文章于 2022-10-19 22:05:17 发布

贤云

最新推荐文章于 2022-10-19 22:05:17 发布

阅读量75

点赞数

本文链接：https://blog.csdn.net/weixin_43880379/article/details/104607597

版权

功能介绍

BasicRESTCmdlet主要为了化简REST接口设计实现，使用方式模仿SpringMVC，整合ucore之前AbstractRESTCmdlet的模式使用

针对之前的编程模式，主要增加如下的特点：

REST参数通过注解注入实现，可以在注解中配置对应的字段名、数据来源(Header或者RequestParam)、验证参数等。
自动输出参数日志、参数验证错误日志等。
返回值可以用之前的AbstractRESTResult，也可以直接返回一个对象，系统自动封装JSONRESTResult对象。

使用范例

基本使用模式如下:

 
     01/*在这里粘贴JAVA代码，包括缩进空格。*/
 
     02@Controller
 
@RESTAnnotate(URL = "/dev/test", Methods = HttpMethod.GET) 
 
public class BasicRestTestHandler extends BasicRESTCmdlet { 
 
     05 
 
    private static transient Logger logger = LoggerFactory.getLogger(BasicRestTestHandler.class); 
 
     07 
 
     08 
 
    @RESTAPI 
 
    public Student doTestRequest( 
 
            @StringParam(value = "name", required = false, validated = true, maxLength = 2) 
 
            String name, 
 
            @IntParam(value = "age", source = RequestSource.RequestParam,required = false, min = 0, max = 25) 
 
            int age, 
 
            @TypedParam(value = "student", required = false, type = Student.class) 
 
            Student student， 
 
 @DateParam(value = "start") 
 
            Date startDate 
 
    ) 
 
    { 
 
     21 
 
        HashMap myMap = new HashMap(); 
 
        myMap.put("name", name); 
 
        myMap.put("age", age); 
 
        if (student == null) 
 
        { 
 
            logger.info("----> Student is empty"); 
 
        } 
 
        else 
 
        { 
 
            logger.info("----> Student.name: {}, Student.age: {}", student.getName(), 
 
                    student.getAge()); 
 
        } 
 
        return student; 
 
    } 
 
     36}

使用方法与约定

将REST实现类继承自BasicRESTCmdlet，增加RESTAnnotate、Controller等基本注解
任意实现一个方法，增加REST API注解(在一个类中目前只支持一个RESTAPI注解)
方法的参数中，增加IntParam、StringParam、TypedParam等注解，并配置基本参数

注解使用说明

IntParam

作用

绑定Integer型数据。

注解声明

 
       01 @Target({ElementType.PARAMETER}) 
 
       02@Documented
 
       03 @Retention(RetentionPolicy.RUNTIME) 
 
       04 public @interface IntParam { 
 
       05     String value(); 
 
       06     RequestSource source() default RequestSource.HeaderParam; 
 
       07     RequestParamType paramType() default RequestParamType.Integer; 
 
       08     boolean required() default true; 
 
       09     boolean validated() default false; 
 
       10     int min() default Integer.MIN_VALUE; 
 
       11     int max() default Integer.MAX_VALUE; 
 
       12}

常用配置参数说明

value：绑定到REST请求中的参数名

ResourceSource：选择参数取值的来源，默认为Header，可以配置成RequestParameter

required：配置是否为必选参数。如果为false，并且该参数没有传值，则默认为0

validated：配置是否验证，必须在required为true才能生效。当前验证规则只有一个：最大值和最小值之间的范围，在min和max中配置。

StringParam

作用

绑定Integer型数据

注解声明

 
       01/*在这里粘贴JAVA代码，包括缩进空格。*/
 
       02 @Target({ElementType.PARAMETER}) 
 
       03@Documented
 
       04 @Retention(RetentionPolicy.RUNTIME) 
 
       05 public @interface StringParam { 
 
       06     String value(); 
 
       07     RequestSource source() default RequestSource.HeaderParam; 
 
       08     RequestParamType paramType() default RequestParamType.String; 
 
       09     boolean required() default true; 
 
       10     boolean validated() default false; 
 
       11     int maxLength() default Integer.MAX_VALUE; 
 
       12}