本文共 3104 字,大约阅读时间需要 10 分钟。
在业务开发中,有时我们需要将特定字段从模型中导出到CSV文件中。然而,直接暴露所有字段可能会导致敏感信息泄露。因此,我们需要一个灵活且安全的方式来控制导出行为。接下来,我将详细讲解如何通过自定义注解和反射机制实现这一目标。
首先,我们需要定义一个自定义注解ExportFieldAnnotation。这个注解将用于标记需要导出的字段。
@Target(ElementType.FIELD)@Retention(RetentionPolicy.RUNTIME)public @interface ExportFieldAnnotation {} 这个注解使用了@Target(ElementType.FIELD),说明它只能修饰字段。@Retention(RetentionPolicy.RUNTIME)告诉编译器在运行时保留这个注解。
接下来,我们在需要导出的字段上添加这个注解。例如,假设IndicatorModel类有以下字段:
public class IndicatorModel { private String indexId; @ExportFieldAnnotation private String indexName; @ExportFieldAnnotation private String indexRule; @ExportFieldAnnotation private String indexField; @ExportFieldAnnotation private Integer indexType; // 私有 @ExportFieldAnnotation private Integer sort; // 公有 // getter和setter方法} 在导出时,我们需要遍历模型的字段,检查每个字段是否带有ExportFieldAnnotation。
我们可以通过反射机制获取字段的注解信息,然后将符合条件的字段导出到CSV文件中。例如:
public static String genTitle(Field[] fAll) { List titles = new ArrayList<>(); for (Field field : fAll) { if (field.getAnnotation(ExportFieldAnnotation.class) != null) { titles.add(field.getName()); } } return String.join(",", titles);} 当传入模型的所有字段时,函数将检查每个字段的注解。如果字段有注解,则将其名称添加到标题列表中。
在Java中,元注解是用来定义其他注解的注解。以下是几个常用的元注解及其作用:
@Target(ElementType)
指定注解作用的目标范围,例如字段、方法、类等。ElementType的可能取值包括: CONSTRUCTOR:用于构造器。FIELD:用于字段。LOCAL_VARIABLE:用于局部变量。METHOD:用于方法。PACKAGE:用于包。PARAMETER:用于参数。TYPE:用于类、接口或枚举。@Retention(RetentionPolicy)
控制注解的生命周期。RetentionPolicy的可能取值包括: SOURCE:在源代码中有效。CLASS:在编译后的类文件中有效。RUNTIME:在运行时有效。@Documented
说明注解应该被包含在Javadoc文档中。尽管这是一个标记注解,但它对代码没有其他影响。@Inherited
指示注解是否应该被子类继承。只有当注解的RetentionPolicy为RUNTIME时,这个注解才会被继承。自定义注解
使用@interface定义注解,注解中的每个方法对应一个参数,返回类型只能是基本类型、String、Class、Enum或Annotation。例如:@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface ExecTime { String value() default "";}为了更深入地理解注解的应用,我们可以使用AspectJ来实现注解驱动的业务逻辑。例如,定义一个注解ExecTime,用于记录方法执行的时间。
@Aspect@Componentpublic class MethodTimeAspect { private static final Logger logger = LoggerFactory.getLogger(MethodTimeAspect.class); @Pointcut("@annotation(com.usst.user.auth.annotation.ExecTime)") public void pointCut() {} @Around("pointCut()") public Object useTime(ProceedingJoinPoint joinPoint) { Object out = null; try { String className = joinPoint.getTarget().getClass().getSimpleName(); logger.info(" Method [%s.%s()] start", className, joinPoint.getSignature().getName()); long start = System.currentTimeMillis(); out = joinPoint.proceed(); long elapsedTime = System.currentTimeMillis() - start; logger.info(" Method [%s.%s()] execution time: %sms", className, joinPoint.getSignature().getName(), elapsedTime); } catch (Throwable throwable) { logger.error("aop record method exec time error", throwable); } return out; }} 当在控制器层的接口上添加@ExecTime注解时,AspectJ会织入到方法执行的逻辑中,记录每个方法的执行时间和响应时间。
通过以上方法,我们可以灵活地控制哪些字段或方法需要被导出或记录,从而提高代码的可维护性和扩展性。
转载地址:http://ipbyz.baihongyu.com/