自定义日期格式化注解

1、注解

/**
 * 日期字段格式化
 *
 * @author chenmeng
 */
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface ExcelDateTimeFormat {

    /**
     * @return 日期格式
     */
    String pattern();

}

知识点说明：

1. 元注解

   • 元注解是用于注解其他注解的注解。
   • 常见的元注解包括 @Retention、@Target、@Documented 和 @Inherited。

2. @Target

   • 用途：指定注解可以应用的目标元素类型。
   • 参数：{ElementType.FIELD} 表示该注解只能应用于字段（属性）。
   • 作用：确保注解不会被误用在其他地方，如方法、类等。

3. @Retention

   • 用途：指定注解的保留策略，即注解在什么阶段会被保留。
   • 参数：RetentionPolicy.RUNTIME 表示注解会在运行时保留，可以通过反射访问。
   • 作用：允许在运行时通过反射获取注解的信息，通常用于框架或库中动态处理注解。

4. @Inherited

   • 用途：指定注解是否可以被子类继承。
   • 作用：只有当注解类型应用于类时，@Inherited 才有效。对于方法、字段等其他元素无效。
   • 注意：在这个例子中，注解是应用于字段的，所以 @Inherited 实际上不会生效。@Inherited 主要用于类级别的注解。

2、转换类

/**
 * 日期字段格式转换类
 *
 * @author chenmeng
 */
public class DateTimeConverter implements Converter<String> {

    public static final String PATTERN_DATE_IMPORT = "yyyy-MM-dd";
    public static final String PATTERN_DATE_EXPORT = "yyyy年MM月dd日";

    public static final String PATTERN_DATETIME_IMPORT = "yyyy-MM-dd HH:mm:ss";
    public static final String PATTERN_DATETIME_EXPORT = "yyyy年MM月dd日 HH时mm分ss秒";

    @Override
    public Class<?> supportJavaTypeKey() {
        throw new UnsupportedOperationException("暂不支持，也不需要");
    }

    @Override
    public CellDataTypeEnum supportExcelTypeKey() {
        throw new UnsupportedOperationException("暂不支持，也不需要");
    }

    /**
     * 导入
     */
    @Override
    public String convertToJavaData(ReadCellData readCellData, ExcelContentProperty contentProperty,
                                    GlobalConfiguration globalConfiguration) {
        String value = readCellData.getStringValue();
        if (StrUtil.isBlank(value)) {
            return null;
        }
        // 转换成日期类型
        DateTime dateTime = DateUtil.parse(value);
        // 获取需要格式
        String pattern = getPattern(contentProperty);
        return DateUtil.format(dateTime, pattern);
    }

    /**
     * 导出
     */
    @Override
    public WriteCellData<String> convertToExcelData(String dateStr, ExcelContentProperty contentProperty,
                                                    GlobalConfiguration globalConfiguration) {
        if (dateStr == null) {
            return null;
        }
        // 转换成日期类型
        DateTime dateTime = DateUtil.parse(dateStr);
        // 获取需要格式
        String pattern = getPattern(contentProperty);
        return new WriteCellData<>(DateUtil.format(dateTime, pattern));
    }

    private static String getPattern(ExcelContentProperty contentProperty) {
        return contentProperty.getField().getAnnotation(ExcelDateTimeFormat.class).pattern();
    }
}