Используйте тип Enum в качестве параметра значения для @ RolesAllowed-Annotation - PullRequest
Новая
       38

Используйте тип Enum в качестве параметра значения для @ RolesAllowed-Annotation

54 голосов
/ 17 июля 2010

Я занимаюсь разработкой корпоративного приложения Java, в настоящее время занимаюсь вопросами безопасности Java EE, чтобы ограничить доступ к определенным функциям для определенных пользователей. Я настроил сервер приложений и все, и теперь я использую аннотацию RolesAllowed для защиты методов: 

@Documented
@Retention (RUNTIME)
@Target({TYPE, METHOD})
public @interface RolesAllowed {
    String[] value();
}

Когда я использую аннотацию, подобную этой, она отлично работает: 

@RolesAllowed("STUDENT")
public void update(User p) { ... }

Но это не то, что я хочу, так как я должен использовать строку здесь, рефакторинг становится трудным, и могут произойти опечатки. Поэтому вместо использования строки я бы хотел использовать значение Enum в качестве параметра для этой аннотации. Enum выглядит так: 

public enum RoleType {
    STUDENT("STUDENT"),
    TEACHER("TEACHER"),
    DEANERY("DEANERY");

    private final String label;

    private RoleType(String label) {
        this.label = label;
    }

    public String toString() {
        return this.label;
    }
}

Поэтому я попытался использовать Enum в качестве параметра, подобного этому: 

@RolesAllowed(RoleType.DEANERY.name())
public void update(User p) { ... }

Но затем я получаю следующую ошибку компилятора, хотя Enum.name просто возвращает строку (которая всегда постоянна, не так ли?).

Значение атрибута аннотации RolesAllowed.value должно быть константным выражением`

Следующее, что я попробовал, было добавить дополнительную заключительную строку в мой Enum: 

public enum RoleType {
    ...
    public static final String STUDENT_ROLE = STUDENT.toString();
    ...
}

Но это также не работает как параметр, что приводит к той же ошибке компилятора: 

// The value for annotation attribute RolesAllowed.value must be a constant expression
@RolesAllowed(RoleType.STUDENT_ROLE)

Как мне добиться желаемого поведения? Я даже реализовал свой собственный перехватчик, чтобы использовать свои собственные аннотации, что прекрасно, но слишком много строк кода для такой маленькой проблемы.

ОТКАЗ

Этот вопрос изначально был вопросом Scala . Я обнаружил, что Scala не является источником проблемы, поэтому я сначала пытаюсь сделать это на Java.

Ответы [ 4 ]

31 голосов
/ 17 июля 2010

Не думаю, что ваш подход к использованию перечислений сработает.Я обнаружил, что ошибка компилятора исчезла, если я изменил поле STUDENT_ROLE в вашем последнем примере на постоянную строку, а не на выражение: 

public enum RoleType { 
  ...
  public static final String STUDENT_ROLE = "STUDENT";
  ...
}

Однако это означает, что значения перечисления не будутне будет использоваться где-либо, потому что вы вместо этого будете использовать строковые константы в аннотациях.

Мне кажется, вам было бы лучше, если бы ваш класс RoleType не содержал ничего, кроме связки статических элементов.final String константы.

Чтобы понять, почему ваш код не компилируется, я заглянул в Спецификацию языка Java (JLS).В JLS для аннотаций указано, что для аннотации с параметром типа T и значением V ,

, если T является примитивным типом или String, V является константным выражением.

A константное выражение включает, помимо прочего,

Квалифицированные имена формы TypeName . Идентификатор , относящийся к константным переменным

и константная переменная определяется как

переменная простого типа илитип String, который является окончательным и инициализируется константным выражением времени компиляции

20 голосов
/ 21 августа 2017

Как насчет этого? 

public enum RoleType {
    STUDENT(Names.STUDENT),
    TEACHER(Names.TEACHER),
    DEANERY(Names.DEANERY);

    public class Names{
        public static final String STUDENT = "Student";
        public static final String TEACHER = "Teacher";
        public static final String DEANERY = "Deanery";
    }

    private final String label;

    private RoleType(String label) {
        this.label = label;
    }

    public String toString() {
        return this.label;
    }
}

И в аннотации вы можете использовать его как 

@RolesAllowed(RoleType.Names.DEANERY)
public void update(User p) { ... }

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

Или это звучит совершенно глупо? :)

9 голосов
/ 06 октября 2011

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

/**
 * empty interface which must be implemented by enums participating in
 * annotations of "type" @RolesAllowed.
 */
public interface RoleType {
    public String toString();
}

/** meta annotation to be applied to annotations that have enum values implementing RoleType. 
 *  the value() method should return an array of objects assignable to RoleType*.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ANNOTATION_TYPE})
public @interface RolesAllowed { 
    /* deliberately empty */ 
}

@RolesAllowed
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, METHOD})
public @interface AcademicRolesAllowed {
    public AcademicRoleType[] value();
}

public enum AcademicRoleType implements RoleType {
    STUDENT, TEACHER, DEANERY;
    @Override
    public String toString() {
        return name();
    }
}


public class RolesAllowedUtil {

    /** get the array of allowed RoleTypes for a given class **/
    public static List<RoleType> getRoleTypesAllowedFromAnnotations(
            Annotation[] annotations) {
        List<RoleType> roleTypesAllowed = new ArrayList<RoleType>();
        for (Annotation annotation : annotations) {
            if (annotation.annotationType().isAnnotationPresent(
                    RolesAllowed.class)) {
                RoleType[] roleTypes = getRoleTypesFromAnnotation(annotation);
                if (roleTypes != null)
                    for (RoleType roleType : roleTypes)
                        roleTypesAllowed.add(roleType);
            }
        }
        return roleTypesAllowed;
    }

    public static RoleType[] getRoleTypesFromAnnotation(Annotation annotation) {
        Method[] methods = annotation.annotationType().getMethods();
        for (Method method : methods) {
            String name = method.getName();
            Class<?> returnType = method.getReturnType();
            Class<?> componentType = returnType.getComponentType();
            if (name.equals("value") && returnType.isArray()
                    && RoleType.class.isAssignableFrom(componentType)) {
                RoleType[] features;
                try {
                    features = (RoleType[]) (method.invoke(annotation,
                            new Object[] {}));
                } catch (Exception e) {
                    throw new RuntimeException(
                            "Error executing value() method in "
                                    + annotation.getClass().getCanonicalName(),
                            e);
                }
                return features;
            }
        }
        throw new RuntimeException(
                "No value() method returning a RoleType[] type "
                        + "was found in annotation "
                        + annotation.getClass().getCanonicalName());
    }

}

public class RoleTypeTest {

    @AcademicRolesAllowed({DEANERY})
    public class DeaneryDemo {

    }

    @Test
    public void testDeanery() {
        List<RoleType> roleTypes = RolesAllowedUtil.getRoleTypesAllowedFromAnnotations(DeaneryDemo.class.getAnnotations());
        assertEquals(1, roleTypes.size());
    }
}
0 голосов
/ 21 января 2019

Я решил эту проблему, добавив аннотацию @RoleTypesAllowed и добавив источник метаданных.Это работает очень хорошо, если существует только один тип enum, который необходимо поддерживать.Для нескольких типов перечислений см. Пост anomolos.

Ниже RoleType - моя роль enum.

@Documented
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface RoleTypesAllowed {
  RoleType[] value();
}

Затем я добавил следующий источник метаданных в spring ... 

@Slf4j
public class CemsRolesAllowedMethodSecurityMetadataSource
    extends AbstractFallbackMethodSecurityMetadataSource {

  protected Collection<ConfigAttribute> findAttributes(Class<?> clazz) {
    return this.processAnnotations(clazz.getAnnotations());
  }

  protected Collection<ConfigAttribute> findAttributes(Method method, Class<?> targetClass) {
    return this.processAnnotations(AnnotationUtils.getAnnotations(method));
  }

  public Collection<ConfigAttribute> getAllConfigAttributes() {
    return null;
  }

  private List<ConfigAttribute> processAnnotations(Annotation[] annotations) {
    if (annotations != null && annotations.length != 0) {
      List<ConfigAttribute> attributes = new ArrayList();

      for (Annotation a : annotations) {
        if (a instanceof RoleTypesAllowed) {
          RoleTypesAllowed ra = (RoleTypesAllowed) a;
          RoleType[] alloweds = ra.value();
          for (RoleType allowed : alloweds) {
            String defaultedAllowed = new RoleTypeGrantedAuthority(allowed).getAuthority();
            log.trace("Added role attribute: {}", defaultedAllowed);
            attributes.add(new SecurityConfig(defaultedAllowed));
          }
          return attributes;
        }
      }
    }
    return null;
  }
}
...