欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

JSON的使用 | Jackson | FastJson

程序员文章站 2022-06-17 10:26:17
...

JSON

什么是JSON?

  • JSON(JavaScript Object Notation, NS对象标记)是一种轻量级的数据交换格式,目前使用特别广泛。
  • 采用完全独立于编程语言的文本格式来存储和表示数据。
  • 简洁和清晰的层次结构使得JSON成为理想的数据交换语言。
  • 易于人阅读和编写,同时也易于机器解析和生成,并有效地提升网络传输效率。

在JavaScript语言中,一切都是对象。因此,任何JavaScript 支持的类型都可以通过JSON来表示,例如字符串、数字、对象、数组等。看看他的要求和语法格式:

  • 对象表示为键值对,数据由逗号分隔
  • 花括号保存对象
  • 方括号保存数组

JSON键值对是用来保存JavaScript对象的一种方式,和JavaScript对象的写法也大同小异,键/值对组合中的键名写在前面并用双引号 “” 包裹,使用冒号 : 分隔,然后紧接着值:

{"name":"zhangsan"}
{"age":"3"}
{"sex":"男"}
  • JSON是JavaScript对象的字符串表示法,它使用文本表示一个JS对象的信息,本质是一个字符串。
var obj = {a:'Hello',b:'World'};//这是一个对象,注意键名也是可以使用引号包裹的
var json = '{a:"Hello",b:"World"}';//这是一个JSON字符串,本质是一个字符串

JSON和 JavaScript 对象互转

  • 要实现从JSON字符串转换为JavaScript对象,使用JSON.parse()方法:
var obj = JSON.parse('{a:"Hello",b:"World"}');
//结果是 {a:'Hello',b:'World'}
  • 要实现从JavaScript对象转化为JSON字符串,使用JSON.stringify()方法:
var json = JSON.stringify({a:'Hello',b:'World'});
//结果是 '{a:"Hello",b:"World"}'

代码测试

  1. 新建一个module,spring-05-json,添加web支持
  2. 在web目录下新建一个jsontest.html,编写测试内容
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>

    <script type="text/javascript">
        //编写一个JavaScript对象
        var user={
            name:"张三",
            age:3,
            sex:"男"
        };
        console.log(user);
		
        //将 js 对象转换为 json 对象;
        var json = JSON.stringify(user);
        console.log(json);

        //将 json 对象转换为 js 对象;
        var obj = JSON.parse(json);
        console.log(obj);
    </script>
</head>
<body>

</body>
</html>
  1. 在IDEA中使用浏览器打开,查看控制台输出。

JSON的使用 | Jackson | FastJson

Controller返回 JSON数据

  • Jackson应该是目前比较好的json解析工具了
  • 当然工具不止这一个,比如还有阿里巴巴的 fastjson 等等。
  • 我们这里使用 Jackson,使用它需要导入它的jar包。

Jackson

<dependency>
  <groupId>com.fasterxml.jackson.core</groupId>
  <artifactId>jackson-databind</artifactId>
  <version>2.9.9</version>
</dependency>
  • 配置SpringMVC需要的配置文件

web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
        version="4.0">

   <!--1.注册servlet-->
   <servlet>
       <servlet-name>SpringMVC</servlet-name>
       <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
       <!--通过初始化参数指定SpringMVC配置文件的位置,进行关联-->
       <init-param>
           <param-name>contextConfigLocation</param-name>
           <param-value>classpath:springmvc-servlet.xml</param-value>
       </init-param>
       <!-- 启动顺序,数字越小,启动越早 -->
       <load-on-startup>1</load-on-startup>
   </servlet>

   <!--所有请求都会被springmvc拦截 -->
   <servlet-mapping>
       <servlet-name>SpringMVC</servlet-name>
       <url-pattern>/</url-pattern>
   </servlet-mapping>

   <filter>
       <filter-name>encoding</filter-name>
       <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
       <init-param>
           <param-name>encoding</param-name>
           <param-value>utf-8</param-value>
       </init-param>
   </filter>
   <filter-mapping>
       <filter-name>encoding</filter-name>
       <url-pattern>/*</url-pattern>
   </filter-mapping>
</web-app>

springmvc.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation=" http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/mvc
       http://www.springframework.org/schema/mvc/spring-mvc.xsd
       http://www.springframework.org/schema/context
       http://www.springframework.org/schema/context/spring-context.xsd">

    <!--自动扫描包,让指定包下的注解生效,有IOC容器统一管理-->
    <context:component-scan base-package="com.kuang.controller"/>

    <!--让springmvc 不处理静态资源-->
    <mvc:default-servlet-handler/>

    <!--开启注解支持-->
    <mvc:annotation-driven/>

    <!--配置视图解析器-->
    <bean id="internalResourceViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <!--前缀解析器-->
        <property name="prefix" value="/WEB-INF/jsp/"></property>
        <!--后缀解析器-->
        <property name="suffix" value=".jsp"></property>
    </bean>

</beans>
  • 编写一个User实体类
//需要导入lombok
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private String name;
    private int age;
    private String sex;
}
  • 编写一个测试类Controller
@Controller
public class UserController {
    @RequestMapping("/json1")
    @ResponseBody //他就不去走视图解析器,直接返回一个字符串
    public String json1() throws Exception{
        //jackson
        ObjectMapper mapper =new ObjectMapper();

        User user = new User("张三01",21,"男");
        String str = mapper.writeValueAsString(user);
        return str;
    }
}

配置Tomcat , 启动测试一下!

http://localhost:8080/json1

JSON的使用 | Jackson | FastJson

发现出现了乱码问题,我们需要设置一下他的编码格式为utf-8,以及它返回的类型;

通过@RequestMapping的produces属性来实现,修改下代码:

//没有在配置文件中配置,可以单个解决乱码
//produces:指定响应体返回类型和编码
@RequestMapping(value = "/json1",produces = "application/json;charset=utf-8")

再次测试, http://localhost:8080/json1 , 乱码问题OK!

JSON的使用 | Jackson | FastJson

【注意:使用json记得处理乱码问题】

乱码统一解决

上一种方法比较麻烦,如果项目中有许多请求则每一个都要添加,可以通过Spring配置统一指定,这样就不用每次都去处理了!

我们可以在springmvc的配置文件上添加一段消息StringHttpMessageConverter转换配置!

<mvc:annotation-driven>
   <mvc:message-converters register-defaults="true">
       <bean class="org.springframework.http.converter.StringHttpMessageConverter">
           <constructor-arg value="UTF-8"/>
       </bean>
       <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
           <property name="objectMapper">
               <bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean">
                   <property name="failOnEmptyBeans" value="false"/>
               </bean>
           </property>
       </bean>
   </mvc:message-converters>
</mvc:annotation-driven>

返回json字符串统一解决

在类上直接使用 @RestController ,这样子,里面所有的方法都只会返回 json 字符串了,不用再每一个都添加@ResponseBody !我们在前后端分离开发中,一般都使用 @RestController ,十分便捷!

@RestController
public class UserController {

   //produces:指定响应体返回类型和编码
   @RequestMapping(value = "/json1")
   public String json1() throws JsonProcessingException {
       //创建一个jackson的对象映射器,用来解析数据
       ObjectMapper mapper = new ObjectMapper();
       //创建一个对象
       User user = new User("张三1号", 3, "男");
       //将我们的对象解析成为json格式
       String str = mapper.writeValueAsString(user);
       //由于@ResponseBody注解,这里会将str转成json格式返回;十分方便
       return str;
  }

}

启动tomcat测试,结果都正常输出!

测试集合输出

增加一个新的方法

@RequestMapping("/json2")
@ResponseBody //他就不去走视图解析器,直接返回一个字符串
public String json2() throws Exception{

    //jackson
    ObjectMapper mapper =new ObjectMapper();

    List<User> userList = new ArrayList<User>();

    User user1 = new User("张三01",21,"男");
    User user2 = new User("张三02",21,"男");
    User user3 = new User("张三03",21,"男");
    User user4 = new User("张三04",21,"男");

    userList.add(user1);
    userList.add(user2);
    userList.add(user3);
    userList.add(user4);

    String str = mapper.writeValueAsString(userList);
    return str;
}

运行结果 : 没有任何问题!

JSON的使用 | Jackson | FastJson

输出时间对象

增加一个新的方法

@RequestMapping("/json3")
public String json3() throws JsonProcessingException {

   ObjectMapper mapper = new ObjectMapper();

   //创建时间一个对象,java.util.Date
   Date date = new Date();
   //将我们的对象解析成为json格式
   String str = mapper.writeValueAsString(date);
   return str;
}

运行结果 :

JSON的使用 | Jackson | FastJson

  • 默认日期格式会变成一个数字,是1970年1月1日到当前日期的毫秒数!
  • Jackson 默认是会把时间转成timestamps形式

解决方案一:使用SimpleDateFormat,自定义时间格式

@RequestMapping("/json3")
@ResponseBody //他就不去走视图解析器,直接返回一个字符串
public String json3() throws Exception {
  //jackson
  ObjectMapper mapper = new ObjectMapper();

  Date date = new Date();

  //自定义日期格式
  SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");

  return mapper.writeValueAsString(sdf.format(date));
}

解决方案二:取消timestamps形式 , 自定义时间格式

@RequestMapping("/json4")
@ResponseBody //他就不去走视图解析器,直接返回一个字符串
public String json4() throws Exception {
  //jackson
  ObjectMapper mapper = new ObjectMapper();

  //不使用时间戳的方式、
  mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS,false);
  //自定义日期格式
  SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");
  mapper.setDateFormat(sdf);

  Date date = new Date();
  return mapper.writeValueAsString(date);
}

运行结果 : 成功的输出了时间!

JSON的使用 | Jackson | FastJson

抽取成工具类

如果要经常使用的话,这样是比较麻烦的,我们可以将这些代码封装到一个工具类中;我们去编写下

public class JSONUtils {

    public static String getJson(Object object){
        return  getJson(object,"yyyy-MM-dd HH:mm:ss");
    }

    public static String getJson(Object object,String dateFormat){
        //jackson
        ObjectMapper mapper = new ObjectMapper();

        //不使用时间戳的方式
        mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS,false);
        //自定义日期格式
        SimpleDateFormat sdf = new SimpleDateFormat(dateFormat);
        mapper.setDateFormat(sdf);

        try {
            return mapper.writeValueAsString(object);
        } catch (JsonProcessingException e) {
            e.printStackTrace();
        }
        return null;
    }

}

此时的代码更加简洁。

@RequestMapping("/json5")
@ResponseBody //他就不去走视图解析器,直接返回一个字符串
public String json5() throws Exception {
  Date date = new Date();
  return JSONUtils.getJson(date,"yyyy-MM-dd HH:mm:ss");
}

FastJson

fastjson.jar是阿里开发的一款专门用于Java开发的包, 可以方便的实现json对象与JavaBean对象的转换,实现JavaBean对象与json字符串的转换,实现json对象 与json字符串的转换。实现json的转换方法很多,最后的实现结果都是一样的。

导入pom依赖

<dependency>
  <groupId>com.alibaba</groupId>
  <artifactId>fastjson</artifactId>
  <version>1.2.20</version>
</dependency>

fastjson三个主要的类:

  • 【JSONObject代表json对象】
    • JSONObject实现了Map接口,猜想JSONObject底层操作是由Map实现的。
    • JSONObject对应 json对象,通过各种形式的get()方法可以获取json对象中的数据,也可利用诸如size(),isEmpty()等方法获取"键: 值"对的个数和判断是否为空。其本质是通过实现Map接口并调用接口中的方法完成的。
  • 【JSONArray代表json对象数组】
    • 内部是有List接口中的方法来完成操作的。
  • 【JSON代表JSONObject和 JSONArray的转化】
    • JSON类源码分析与使用。
    • 仔细观察这些方法,主要是实现json对象,json对象数组,javabean对象,json字符串之间的相互转化。

代码测试:

@RequestMapping("/json6")
@ResponseBody
public String json6() throws Exception {
  List<User> userList = new ArrayList<User>();
  User user1 = new User("张三01",21,"男");
  User user2 = new User("张三02",21,"男");
  User user3 = new User("张三03",21,"男");
  User user4 = new User("张三04",21,"男");
  userList.add(user1);
  userList.add(user2);
  userList.add(user3);
  userList.add(user4);

  System.out.println("****Java对象 转 JSON字符串****");
  String str1 = JSON.toJSONString(userList);
  System.out.println(str1);
  String str2 = JSON.toJSONString(user1);
  System.out.println(str2);

  System.out.println("****JSON字符串 转 Java对象****");
  User jp_user1 = JSON.parseObject(str2, User.class);
  System.out.println(jp_user1);

  System.out.println("****Java对象 转 JSON对象****");
  JSONObject jsonObject1 = (JSONObject) JSON.toJSON(user2);
  System.out.println(jsonObject1.getString("name"));

  System.out.println("****JSON对象 转 Java对象****");
  User to_java_user = JSON.toJavaObject(jsonObject1, User.class);
  System.out.println(to_java_user);

  return "Hello";
}

如果有收获!!! 希望老铁们来个三连,点赞、收藏、转发。
创作不易,别忘点个赞,可以让更多的人看到这篇文章,顺便鼓励我写出更好的博客