SpringMVC添加自定义注解格式化数据

柔情只为你懂 2022-07-12 23:18 267阅读 0赞

## 遇到一个问题 ##

接口传入开始时间、结束时间，格式为yyyyMMdd，要求查询的数据必须用给定的时间段进行过滤。  
比如

http://127.0.0.1:8095/iportal-dev/v1/sms/sending/list?stime=20161001&etime=20161130

但是服务端接受时间后，**按照业务要求**，应该格式为

20161001 00:00:00< 时间段 <20161130 23:59:59

stime可以使用springMVC默认提供的`@DateTimeFormat(pattern = "yyyyMMdd")`可以得到正确的开始时间，但是结束时间，**默认的格式注解就不能完成需求了~**

## 仿照@DateTimeFormat自定义接口 ##

因为是仿照的，有些可以用的方法就继承下来了，并不需要大改。

### @MyDateTimeFormat注解 ###

package cn.jpush.iportal.common.support;
    
    import org.springframework.format.annotation.DateTimeFormat.ISO;
    
    import java.lang.annotation.*;
    
    /** * 使用方法与@DateTimeFormat一致，但是通过它进行注解的字段，会格式化为当天的23:59:59. * 其他格式的用法也可以支持. * @author Administrator * */
    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    @Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER, ElementType.ANNOTATION_TYPE})
    public @interface MyDateTimeFormat { 
    
        String style() default "SS";
    
        ISO iso() default ISO.NONE;
    
        String pattern() default "";
    
    }

### @MyDateTimeFormat注解处理类 ###

package cn.jpush.iportal.common.support;
    
    import org.springframework.context.support.EmbeddedValueResolutionSupport;
    import org.springframework.format.AnnotationFormatterFactory;
    import org.springframework.format.Formatter;
    import org.springframework.format.Parser;
    import org.springframework.format.Printer;
    
    import java.util.*;
    
    public class MyDataTimeFormatAnnotationFormatterFactory extends EmbeddedValueResolutionSupport implements AnnotationFormatterFactory<MyDateTimeFormat> { 
    
        private static final Set<Class<?>> FIELD_TYPES;
    
        static {
            Set<Class<?>> fieldTypes = new HashSet<Class<?>>(4);
            fieldTypes.add(Date.class);
            fieldTypes.add(Calendar.class);
            fieldTypes.add(Long.class);
            FIELD_TYPES = Collections.unmodifiableSet(fieldTypes);
        }
    
        @Override
        public Set<Class<?>> getFieldTypes() {
            return FIELD_TYPES;
        }
    
        @Override
        public Printer<?> getPrinter(MyDateTimeFormat annotation, Class<?> fieldType) {
            return getFormatter(annotation, fieldType);
        }
    
        @Override
        public Parser<?> getParser(MyDateTimeFormat annotation, Class<?> fieldType) {
            return getFormatter(annotation, fieldType);
        }
    
        protected Formatter<Date> getFormatter(MyDateTimeFormat annotation, Class<?> fieldType) {
            MyDateFormatter formatter = new MyDateFormatter();
            formatter.setStylePattern(resolveEmbeddedValue(annotation.style()));
            formatter.setIso(annotation.iso());
            formatter.setPattern(resolveEmbeddedValue(annotation.pattern()));
            return formatter;
        }
    
    }

### 重载parse接口 ###

通过调用原来的处理函数`super.parse(text, locale)`，得到转化的Date对象，然后再添加相关的处理业务，然后返回Date。

package cn.jpush.iportal.common.support;
    
    import org.apache.commons.lang3.time.DateUtils;
    import org.springframework.format.datetime.DateFormatter;
    
    import java.text.ParseException;
    import java.util.Calendar;
    import java.util.Date;
    import java.util.Locale;
    
    public class MyDateFormatter extends DateFormatter { 
    
        @Override
        public Date parse(String text, Locale locale) throws ParseException {
            Date target = super.parse(text, locale);
            //+1天
            Date date = DateUtils.ceiling(new Date(target.getTime() + 1), Calendar.DATE);
            //减1ms，得出23:59:59
            Date result =new Date(date.getTime()-1);
            return result;
        }
    }

## 向SpringMVC注册我们的自定义注解处理类 ##

@Configuration
    public class WebConfig extends WebMvcConfigurerAdapter{ 
    
        @Override
        public void addFormatters(FormatterRegistry registry) {
            MyDataTimeFormatAnnotationFormatterFactory annoFormater =new MyDataTimeFormatAnnotationFormatterFactory();
            registry.addFormatterForFieldAnnotation(annoFormater);
        }