SpringBoot中优雅处理日期时间格式化

SpringBoot中优雅处理日期时间格式化

1、介绍

在我们SpringBoot项目中,日期时间的格式化处理一直是很多小伙伴的头疼问题,今天给大家梳理了一下,以后直接拷贝过去使用即可

日期时间格式化根据实际场景需要,可以分下面两种方式进行格式化:

  • 局部格式化:就是针对单一的某个字段进行格式化处理
  • 全局格式化:针对系统所有的字段,都统一按照某种格式化规则进行处理

2、局部格式化

根据MyBatisPlus版本不一样,使用起来还有些区别,因为使用MyBatisPlus2.X版本时,自动生成实体类时,时间类型字段都是Date类型,但是MyBatisPlus3.X版本时,自动生成实体类时,时间类型字段都是LocalDateTime或LocalDate类型2.1、MyBatisPlus2.X

2.1、MyBatisPlus2.X

在实体类中,哪些字段需要进行时间格式化的话,加上@JsonFormat注解即可,如下:

@TableField("start_time")
@JsonFormat(timezone = "GMT+8",pattern = "yyyy-MM-dd")
private Date startTime;

2.2、MyBatisPlus3.X

如果你想对某个字段单独格式化后向前端传输的话,需要使用【@JsonSerialize】注解,使用方式如下:

@JsonSerialize(using = CustomLocatDateSerializer.class)
private LocalDateTime startTime;

需要自定义一个类:CustomLocatDateSerializer

package cn.itsource.date;

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import java.io.IOException;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;

public class CustomLocatDateSerializer extends JsonSerializer<LocalDateTime> {

    @Override
    public void serialize(LocalDateTime value,
                          JsonGenerator gen,
                          SerializerProvider serializers) throws IOException {
        if (value != null) {
            gen.writeString(value.format(DateTimeFormatter.ofPattern("yyyy-MM-dd")));
        }
    }
}

扩展:如果想对其他字段也格式化输出的话,可以这样做:

@JsonSerialize(using = StatusSerialize.class)
private Integer status;
package cn.itsource.config.serialize;

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import java.io.IOException;

public class StatusSerialize extends JsonSerializer<Integer> {

    @Override
    public void serialize(Integer value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        String str = "";
        if (value != null) {
            //课程状态,下线:0 , 上线:1
            if(value == 0){
                str = "已下线了";
            }
            else if(value == 1){
                str = "已上线了";
            }
            else {
                str = "未知状态";
            }
        }
        gen.writeString(str);
    }
}

3、全局格式化

同样,全局格式化时,根据MyBatisPlus版本不一样,处理方式有些不同:

3.1、MyBatisPlus2.X

在需要全局格式化的SpringBoot项目中,新建如下配置类:

package cn.js.config.date;

import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.jackson.Jackson2ObjectMapperBuilderCustomizer;
import org.springframework.boot.jackson.JsonComponent;
import org.springframework.context.annotation.Bean;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.TimeZone;

/**
 * @description: 日期时间全局格式化
 * @auth: wujiangbo(weixin:wjb1134135987)
 */
@JsonComponent
public class LocalDateTimeSerializerConfig {

    @Value("${spring.jackson.date-format:yyyy-MM-dd HH:mm:ss}")
    private String pattern;

    /**
     * Date 类型全局时间格式化
     */
    @Bean
    public Jackson2ObjectMapperBuilderCustomizer jackson2ObjectMapperBuilder() {
        return builder -> {
            TimeZone tz = TimeZone.getTimeZone("UTC");//获取时区
            DateFormat df = new SimpleDateFormat(pattern);//设置格式化模板
            df.setTimeZone(tz);
            builder.failOnEmptyBeans(false)
                    .failOnUnknownProperties(false)
                    .featuresToDisable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS)
                    .dateFormat(df);
        }; }

    /**
     * LocalDate 类型全局时间格式化
     */
    @Bean
    public LocalDateTimeSerializer localDateTimeDeserializer() {
        return new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(pattern));
    }

    @Bean
    public Jackson2ObjectMapperBuilderCustomizer jackson2ObjectMapperBuilderCustomizer() {
        return builder -> builder.serializerByType(LocalDateTime.class, localDateTimeDeserializer());
    }
}

就这样就OK了,但是人会问,这样设置的话,那不就所有的字段都格式化成:yyyy-MM-dd HH:mm:ss 格式了吗,万一我需要展示:yyyy-MM-dd 格式的呢?

不要慌,这时就可以配合第一种@JsonFormat(timezone = “GMT+8”,pattern = “yyyy-MM-dd”)联合使用了,哪些字段需要特殊对待的,就可以单独使用这个@JsonFormat注解进行处理了

3.2、MyBatisPlus3.X

如果你的实体类中日期字段类型为【LocalDateTime】或【LocalDate】,那么全局格式化配置类就不一样了,只需要在项目中新增下面配置类即可:

package cn.js.config;

import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateDeserializer;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateTimeDeserializer;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalTimeDeserializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateSerializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalTimeSerializer;
import com.fasterxml.jackson.module.paramnames.ParameterNamesModule;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.time.format.DateTimeFormatter;

@Configuration
public class JacksonConfig {

    /** 默认日期时间格式 */
    public static final String DEFAULT_DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm:ss";
    /** 默认日期格式 */
    public static final String DEFAULT_DATE_FORMAT = "yyyy-MM-dd";
    /** 默认时间格式 */
    public static final String DEFAULT_TIME_FORMAT = "HH:mm:ss";

    @Bean
    public ObjectMapper objectMapper(){
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
        objectMapper.disable(DeserializationFeature.ADJUST_DATES_TO_CONTEXT_TIME_ZONE);
        JavaTimeModule javaTimeModule = new JavaTimeModule();
        javaTimeModule.addSerializer(LocalDateTime.class,new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)));
        javaTimeModule.addSerializer(LocalDate.class,new LocalDateSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)));
        javaTimeModule.addSerializer(LocalTime.class,new LocalTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));
        javaTimeModule.addDeserializer(LocalDateTime.class,new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)));
        javaTimeModule.addDeserializer(LocalDate.class,new LocalDateDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)));
        javaTimeModule.addDeserializer(LocalTime.class,new LocalTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));
        objectMapper.registerModule(javaTimeModule).registerModule(new ParameterNamesModule());
        return objectMapper;
    }
}

  • 1
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Spring Boot使用MyBatis-Plus修改日期格式,可以通过配置自定义的`ObjectMapper`来实现。下面是一种常见的配置方式: 1. 创建自定义的`ObjectMapper`配置类 首先,创建一个自定义的配置类,用于配置`ObjectMapper`。可以在该类自定义日期格式的序列和反序列方式。例如,创建一个名为`MybatisPlusConfig`的配置类: ```java @Configuration public class MybatisPlusConfig { @Bean public ObjectMapper objectMapper() { ObjectMapper objectMapper = new ObjectMapper(); objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss")); return objectMapper; } } ``` 在上面的配置,我们创建了一个`ObjectMapper`对象,并通过`setDateFormat()`方法设置了日期格式为"yyyy-MM-dd HH:mm:ss"。 2. 配置MyBatis-Plus使用自定义的`ObjectMapper` 接下来,需要配置MyBatis-Plus使用我们自定义的`ObjectMapper`。可以通过在`application.properties`或`application.yml`文件添加以下配置来实现: ```yaml mybatis-plus: configuration: object-mapper: com.example.MybatisPlusConfig#objectMapper ``` 其,`com.example.MybatisPlusConfig#objectMapper`需要替换为你实际创建的自定义`ObjectMapper`配置类的完整路径。 通过以上配置,MyBatis-Plus将会使用我们自定义的`ObjectMapper`来处理日期类型的序列和反序列,从而修改日期格式。 希望以上信息对你有所帮助!如果还有其他问题,请继续提问。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值