java 自定义注解之ElementType.PARAMETER

爱被打了一巴掌 2021-10-06 12:48 314阅读 0赞

### 需求：controller方法获取数据列表，orderPackagePayedAmount等于desc时按照packagePayedAmount字段倒叙排序，等于asc时按照packagePayedAmount字段正叙排序． ###

@Api("项目管理")
    @RestController
    @RequestMapping("/project")
    @Validated
    public class ProjectController extends BaseController { 
    
    @ApiOperation(value = "获取项目管理列表", response = ProjectInfoVO.class)
    @GetMapping("/list")
    public ResultMessage queryProjectList(@OrderBy @ApiParam(value = "已结算数量排序(选填 值为desc/asc)") @RequestParam(value = "packagePayedAmount", required = false) String orderPackagePayedAmount,
                                              @ApiParam(value = "分页数量") @RequestParam(value = "pageSize", defaultValue = "10") int pageSize,
                                              @ApiParam(value = "页码") @RequestParam(value = "pageNo", defaultValue = "1") int pageNo) { 
    
    
            ResultMessage resultMessage = new ResultMessage();
    
            //....
            
            return resultMessage;
        }
    }

--------------------

### 自定义注解OrderBy ###

#### 1.new class OrderBy.如下 ####

package com.antzb.chaos.annotations;
    
    import javax.validation.Constraint;
    import javax.validation.ConstraintValidator;
    import javax.validation.ConstraintValidatorContext;
    import javax.validation.Payload;
    import java.lang.annotation.*;
    
    /** * @Author: qubianzhong * @Date: 18-4-12 下午1:38 */
    @Documented
    @Target({ ElementType.PARAMETER, ElementType.FIELD})
    @Retention(RetentionPolicy.RUNTIME)
    @Constraint(validatedBy = OrderBy.OrderByValidator.class)
    public @interface OrderBy { 
    
        String message() default "{只能为　DESC 或者 ASC}";
    
        Class<?>[] groups() default { };
    
        Class<? extends Payload>[] payload() default { };
    
        class OrderByValidator implements ConstraintValidator<OrderBy, String> { 
    
            @Override
            public void initialize(OrderBy constraintAnnotation) { 
            }
    
            @Override
            public boolean isValid(String value, ConstraintValidatorContext context) { 
                boolean isValid = true;
                if (value != null && !"DESC".equals(value.toUpperCase()) && !"ASC".equals(value.toUpperCase())) { 
                    isValid = false;
                }
                return isValid;
            }
        }
    }

#### 2.在controller类上添加注解@Validated ####

--------------------

### 名词解释： ###

#### @Target ####

*  @Target 说明了Annotation所修饰的对象范围
 *  取值(ElementType)有：
 *  1.CONSTRUCTOR:用于描述构造器
 *  2.FIELD:用于描述域
 *  3.LOCAL\_VARIABLE:用于描述局部变量
 *  4.METHOD:用于描述方法
 *  5.PACKAGE:用于描述包
 *  6.PARAMETER:用于描述参数
 *  7.TYPE:用于描述类、接口(包括注解类型) 或enum声明

#### @Retention ####

*  @Retention定义了该Annotation被保留的时间长短：
 *  某些Annotation仅出现在源代码中，而被编译器丢弃；而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。
 *  取值（RetentionPoicy）有：
 *  1.SOURCE:在源文件中有效（即源文件保留）
 *  2.CLASS:在class文件中有效（即class保留）
 *  3.RUNTIME:在运行时有效（即运行时保留）

#### @Documented ####

*  @Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解，没有成员。