1. 程式人生 > >SpringMVC新增自定義註解格式化資料

SpringMVC新增自定義註解格式化資料

遇到一個問題

介面傳入開始時間、結束時間,格式為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);
    }