spring Mvc json返回json的日期格式问题

Posted 2020-08-17

(一)输出json数据

springmvc中使用jackson-mapper-asl即可进行json输出，在配置上有几点：

1.使用mvc:annotation-driven

2.在依赖管理中添加jackson-mapper-asl

 

<dependency>
        <groupId>org.codehaus.jackson</groupId>
        <artifactId>jackson-mapper-asl</artifactId>
        <version>${jackson.version}</version>
</dependency>

 

 

 

3.使用注解@ResponseBody

mvc:annotation-driven默认加载了json转换器，我们添加了上面的依赖包后就可以使用注解@ResponseBody来返回json数据，比如

 @RequestMapping("json")
 @ResponseBody
public List<User> userList(ModelMap modelMap){
         UserExample example = new UserExample();
         example.createCriteria().andUsernameIsNotNull();
         List<User> users = userMapper.selectByExample(example);
         return users;
}

 

---

 

(二)格式化json输出的日期格式

上面虽然输出了json，但json的date类型的属性都是long值，像在页面取出是国外的日期格式一样，我们需要加一个格式转换，将日期的格式转换成想要的格式：yyyy-MM-dd。

1.使用@JsonFormat(pattern="yyyy-MM-dd HH:mm:ss",timezone = "GMT+8")

在实体类的getter方法上面添加@JsonFormat(pattern="yyyy-MM-dd HH:mm:ss",timezone = "GMT+8") 就可以将json的日期格式化。

我第一次尝试总是失败，后来添加完整的依赖包后成功，需要添加如下几个依赖：

<!-- json数据 -->
         <dependency>
             <groupId>org.codehaus.jackson</groupId>
             <artifactId>jackson-mapper-asl</artifactId>
             <version>${jackson.version}</version>
         </dependency>
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-core</artifactId>
             <version>${jackson.core.version}</version>
         </dependency>
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-databind</artifactId>
             <version>${jackson.core.version}</version>
         </dependency>
 
 
<properties>
         <jackson.version>1.9.13</jackson.version>
         <jackson.core.version>2.4.2</jackson.core.version>
</properties>

 

 

优点是简单方便，缺点是需要在每个需要的属性的getter方法上面添加。宏观的看比较繁琐，但实际开发中也就一行代码的事情，唯一不好的是mybatis自动生成实体类会覆盖。

2.继承ObjectMapper来实现返回json字符串

参考：http://aokunsang.iteye.com/blog/1878985

在上面的方法中虽然简单方便，但缺点也很明显，自动生成代码会覆盖实体类，而且每个日期属性都要手动添加，实际中日期属性又是普遍必备。因此，大可全局处理，统一格式。这里需要说下，在数据库中的date和timestamp都会被mybatis转换成date对象。至于生日精确到日、时间精确到到秒的格式规范可以让显示层做处理。统一成yyyy-MM-dd HH:mm:ss

MappingJacksonHttpMessageConverter主要通过ObjectMapper来实现返回json字符串。这里我们继承该类，注册一个JsonSerializer<T>。然后在配置文件中注入自定义的ObjectMapper。

2.1编写子类继承ObjectMapper

 

package com.demo.common.util.converter;
 
import org.codehaus.jackson.JsonGenerator;
import org.codehaus.jackson.JsonProcessingException;
import org.codehaus.jackson.map.JsonSerializer;
import org.codehaus.jackson.map.ObjectMapper;
import org.codehaus.jackson.map.SerializerProvider;
import org.codehaus.jackson.map.ser.CustomSerializerFactory;
 
import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Date;
 
 /**
  * 解决Date类型返回json格式为自定义格式
  * Created by Administrator on 2016/2/14.
  */
 public class CustomJsonDateConverter extends ObjectMapper {
     public CustomJsonDateConverter(){
         CustomSerializerFactory factory = new CustomSerializerFactory();
         factory.addGenericMapping(Date.class, new JsonSerializer<Date>(){
             @Override
             public void serialize(Date value,
                                   JsonGenerator jsonGenerator,
                                   SerializerProvider provider)
                     throws IOException {
                 SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
                 jsonGenerator.writeString(sdf.format(value));
             }
         });
         this.setSerializerFactory(factory);
     }
 }

 

 

 

2.2配置spring文件

 

 <mvc:annotation-driven>
         <mvc:message-converters>
             <bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter">
                 <property name="objectMapper" ref="customObjectMapper"></property>
             </bean>
         </mvc:message-converters>
</mvc:annotation-driven>
<bean id="customObjectMapper" class="com.demo.common.util.converter.CustomJsonDateConverter"></bean>

 

 

 

 

 

 

 2.3显示层自主决定日期类型长度

这个配置无法和上一个@JsonFormat共同使用。由于全局统一了日期格式，date和datetime以及timestamp都是一个格式，如果生日等date字段需要精简，只能在显示层裁剪。

3.使用内置的日期格式化工具

同样是全局设置json响应的日期格式，但此方法可以和@JsonFormat共存，也就是说可以全局设置一个格式，特定的需求可以使用注解设置。

3.1配置spring文件

 

<mvc:annotation-driven>  
    <!-- 处理responseBody 里面日期类型 -->  
        <mvc:message-converters>  
            <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">  
                <property name="objectMapper">  
                    <bean class="com.fasterxml.jackson.databind.ObjectMapper">  
                        <property name="dateFormat">  
                            <bean class="java.text.SimpleDateFormat">  
                                <constructor-arg type="java.lang.String" value="yyyy-MM-dd HH:mm:ss" />  
                            </bean>  
                        </property>  
                    </bean>  
                </property>  
            </bean>  
        </mvc:message-converters>  
    </mvc:annotation-driven>

 

 

 

3.2配置特定的date

 @JsonFormat(pattern="yyyy-MM-dd",timezone = "GMT+8")
    public Date getBirth() {
        return birth;
    }