Пользовательские аннотации Spring от входа до мастерства

Spring

В процессе развития бизнеса мы столкнемся со всевозможными аннотациями, но собственные аннотации фреймворка не всегда отвечают сложным потребностям бизнеса, мы можем настроить аннотации под свои нужды. В соответствии с местом, где используется аннотация, статья будет разделена на аннотацию поля, метод, аннотацию класса, чтобы ввести пользовательскую аннотацию.

аннотация поля

Аннотации полей обычно используются для проверки соответствия поля требованиям.hibernate-validateЗависимость предоставляет множество аннотаций проверки, таких как@NotNull,@Rangeд., но эти аннотации не способны удовлетворить все бизнес-сценарии. Например, мы хотим, чтобы входящие параметры были в указанномStringВ коллекции существующие аннотации не могут соответствовать требованиям, и вам нужно реализовать их самостоятельно.

пользовательская аннотация

определить@CheckАннотация, через@interfaceобъявить аннотацию

@Target({ ElementType.FIELD}) //只允许用在类的字段上
@Retention(RetentionPolicy.RUNTIME) //注解保留在程序运行期间，此时可以通过反射获得定义在某个类上的所有注解
@Constraint(validatedBy = ParamConstraintValidated.class)
public @interface Check {
    /**
     * 合法的参数值
     * */
    String[] paramValues();

    /**
     * 提示信息
     * */
    String message() default "参数不为指定值";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}
  • @Target определяет, где используется аннотация, чтобы указать, что аннотацию можно объявить перед этими элементами.

ElementType.TYPE: указывает, что аннотацию можно объявить только перед классом.ElementType.FIELD: указывает, что аннотацию можно объявить только перед полем класса.ElementType.METHOD: указывает, что аннотацию можно объявить только перед методом класса.ElementType.PARAMETER: указывает, что аннотацию можно объявить только перед параметром метода.ElementType.CONSTRUCTOR: указывает, что аннотацию можно объявить только перед конструктором класса.ElementType.LOCAL_VARIABLE: указывает, что аннотацию можно объявить только перед локальной переменной.ElementType.ANNOTATION_TYPE: указывает, что аннотацию можно объявить только перед типом аннотации.ElementType.PACKAGE: указывает, что аннотацию можно объявить только перед именем пакета.

  • @Constraint указывает валидатор, связанный с аннотацией, с помощью validatedBy.
  • @Retention используется для описания жизненного цикла класса аннотации.

RetentionPolicy.SOURCE : Аннотации сохраняются только в исходном файле.RetentionPolicy.CLASS: аннотации остаются в файле класса и удаляются при загрузке в JVM.
RetentionPolicy.RUNTIME : аннотации сохраняются во время выполнения программы, и все аннотации, определенные в классе, могут быть получены посредством отражения.

класс валидатора

Класс валидатора должен реализоватьConstraintValidatorобщий интерфейс

public class ParamConstraintValidated implements ConstraintValidator<Check, Object> {
    /**
     * 合法的参数值，从注解中获取
     * */
    private List<String> paramValues;

    @Override
    public void initialize(Check constraintAnnotation) {
        //初始化时获取注解上的值
        paramValues = Arrays.asList(constraintAnnotation.paramValues());
    }

    public boolean isValid(Object o, ConstraintValidatorContext constraintValidatorContext) {
        if (paramValues.contains(o)) {
            return true;
        }

        //不在指定的参数列表中
        return false;
    }
}

первый общий тип параметраCheck: аннотация, второй общий параметрObject: Проверьте тип поля. необходимо реализоватьinitializeиisValidметод,isValidМетод - это логика проверки,initializeИнициализация метода работает

Как пользоваться

определить класс сущности

@Data
public class User {
    /**
     * 姓名
     * */
    private String name;

    /**
     * 性别 man or women
     * */
    @Check(paramValues = {"man", "woman"})
    private String sex;
}

правильноsexПоле плюс галочка, его значение должно бытьwomanилиman

контрольная работа

@RestController("/api/test")
public class TestController {
    @PostMapping
    public Object test(@Validated @RequestBody User user) {
        return "hello world";
    }
}

Обратите внимание, чтоUserдобавить к объекту@ValidatedЗдесь также можно использовать аннотацию@Validаннотация

метод, аннотация класса

В процессе разработки мы столкнулись с такими требованиями.Например, только авторизованные пользователи могут получить доступ к методу в этом классе или конкретному методу.При поиске данных мы ищем сначала не из БД, а сначала из БД.guava cacheнайти в отredisнайти, найти последнийmysql(многоуровневый кеш). В настоящее время мы можем настроить аннотации для выполнения этого требования. Первый сценарий — определить аннотацию для проверки разрешений, а второй сценарий — определитьspring-data-redisПохож на пакет@Cacheableаннотации.

Аннотация разрешения

пользовательская аннотация

@Target({ ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface PermissionCheck {
    /**
     * 资源key
     * */
    String resourceKey();
}

Область действия аннотации находится в классе или методе.

класс перехватчика

public class PermissionCheckInterceptor extends HandlerInterceptorAdapter {
    /**
     * 处理器处理之前调用
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
                             Object handler) throws Exception {
        HandlerMethod handlerMethod = (HandlerMethod)handler;
        PermissionCheck permission = findPermissionCheck(handlerMethod);

        //如果没有添加权限注解则直接跳过允许访问
        if (permission == null) {
            return true;
        }

        //获取注解中的值
        String resourceKey = permission.resourceKey();

        //TODO 权限校验一般需要获取用户信息，通过查询数据库进行权限校验
        //TODO 这里只进行简单演示，如果resourceKey为testKey则校验通过，否则不通过
        if ("testKey".equals(resourceKey)) {
            return true;
        }

        return false;
    }

    /**
     * 根据handlerMethod返回注解信息
     *
     * @param handlerMethod 方法对象
     * @return PermissionCheck注解
     */
    private PermissionCheck findPermissionCheck(HandlerMethod handlerMethod) {
        //在方法上寻找注解
        PermissionCheck permission = handlerMethod.getMethodAnnotation(PermissionCheck.class);
        if (permission == null) {
            //在类上寻找注解
            permission = handlerMethod.getBeanType().getAnnotation(PermissionCheck.class);
        }

        return permission;
    }
}

Логика проверки разрешений такова, что если у вас есть разрешение, вы можете получить к нему доступ, а если у вас нет разрешения, ему не разрешен доступ, по сути, это перехватчик. Сначала нам нужно получить аннотацию, а затем получить поля в аннотации для проверки, и проверка возвращаетtrue, иначе возвратfalse

контрольная работа

 @GetMapping("/api/test")
 @PermissionCheck(resourceKey = "test")
 public Object testPermissionCheck() {
     return "hello world";
 }

Этот метод требует проверки разрешения, поэтому добавленPermissionCheckаннотация

Кэшировать аннотации

пользовательская аннотация

@Target({ ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface CustomCache {
    /**
     * 缓存的key值
     * */
    String key();
}

Аннотации можно использовать в методах или классах, но аннотации кеша обычно используются в методах.

раздел

@Aspect
@Component
public class CustomCacheAspect {
    /**
     * 在方法执行之前对注解进行处理
     *
     * @param pjd
     * @param customCache 注解
     * @return 返回中的值
     * */
    @Around("@annotation(com.cqupt.annotation.CustomCache) && @annotation(customCache)")
    public Object dealProcess(ProceedingJoinPoint pjd, CustomCache customCache) {
        Object result = null;

        if (customCache.key() == null) {
            //TODO throw error
        }

        //TODO 业务场景会比这个复杂的多，会涉及参数的解析如key可能是#{id}这些，数据查询
        //TODO 这里做简单演示，如果key为testKey则返回hello world
        if ("testKey".equals(customCache.key())) {
            return "hello word";
        }

        //执行目标方法
        try {
            result = pjd.proceed();
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        }

        return result;
    }
}

Поскольку аннотация кэша должна иметь возвращаемое значение до выполнения метода, эта аннотация обрабатывается не перехватчиком, а с использованием аспекта для обработки аннотации до выполнения метода. Если аннотация не имеет возвращаемого значения, будет возвращено значение в методе

контрольная работа

@GetMapping("/api/cache")
@CustomCache(key = "test")
public Object testCustomCache() {
    return "don't hit cache";
}

резюме

В этой статье в основном представлены сценарии пользовательских аннотаций, возникающие в процессе разработки и реализации пользовательских аннотаций. Если есть ошибки, поправьте меня. Прикрепил:полный адрес проекта 对外输出结束，继续干活去了

Категории