1.什么是JSON?
-
JSON(JavaScript Object Notation,JS对象标记)是一种轻量级的数据交换格式,目前使用特别广泛。
-
采用完全独立于编程语言的文本格式来存储和表示数据。
-
简洁和清晰的层次结构使得JSON成为理想的数据交换语言。
-
易于人阅读和编写,同时也易于机器解析和生成,并有效地提升网络传输效率。
在JavaScript语言中,一切皆是对象。因此,任何JavaScript支持的类型都可以通过JSON来表示,例如字符串,数字,对象,数组等。它们的要求和语法格式:
-
对象表示为键值对,数据由逗号分隔
-
花括号保存对象
-
方括号保存数组
JSON键值对是用来保存JavaScript对象的一种方式,和JavaScript对象的写法也大同小异,键值对组合中的键名写在前面并用双引号“ ”包裹,使用冒号:分隔,然后紧接着值:
//编写一个JavaScript对象
var user = {
name:"小刘",
age:3,
sex:"男"
};
- JSON是JavaScript对象的字符串表示法,它使用文本表示一个JS对象的信息,本质是一个字符串。
var obj = {name: '小刘', age: 3, sex: '男'};//这是一个JavaScript对象,注意键名也是可以使用引号包裹的
var json = '{"name":"小刘","age":3,"sex":"男"}';//这是一个JSON字符串,本质是一个字符串
JSON和JavaScript对象互转
- 要实现从JSON字符串转换为JavaScript对象,使用JSON.parse()方法:
//将json对象转换为JavaScript对象
var obj = JSON.parse(json);
console.log(obj);
//结果为{name: '小刘', age: 3, sex: '男'}
- 要实现从JavaScript对象转换为JSON字符串,使用JSON.stringify()方法:
//将JavaScript对象转换为json对象
var json = JSON.stringify(user);
console.log(json);
//结果为{"name":"小刘","age":3,"sex":"男"}
代码测试
- 新建一个module,springmvc-05-json,添加web支持
- 在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:"男"
};
//将JavaScript对象转换为json对象
var json = JSON.stringify(user);
console.log(json);
console.log("===========================");
//将json对象转换为JavaScript对象
var obj = JSON.parse(json);
console.log(obj);
</script>
</head>
<body>
</body>
</html>
- 在idea中使用浏览器打开,检查页面,查看控制台输出
2.Controller返回JSON数据
- Jackson目前比较好的json解析工具了,其他工具还有阿里的fastjson等。
- 这里使用Jackson,需要导入它的jar包:
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.10.0</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>
<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>
<servlet-mapping>
<servlet-name>SpringMVC</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
<!--2.配置SpringMVC的乱码过滤器-->
<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-servlet.xml
<?xml version="1.0" encoding="UTF-8" ?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context
https://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/mvc
https://www.springframework.org/schema/mvc/spring-mvc.xsd">
<!--自动扫描指定的包,下面所有注解类交给IOC容器管理-->
<context:component-scan base-package="com.liu.controller"/>
<!--视图解析器(ViewResolver)-->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" id="InternalResourceViewResolver">
<!--前缀-->
<property name="prefix" value="/WEB-INF/jsp/"/>
<!--后缀-->
<property name="suffix" value=".jsp"/>
</bean>
</beans>
需要在WEB-INF目录下新建jsp文件夹
- 编写User实体类,编写测试类UserController
package com.liu.pojo;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
/**
* @author 23862
*/
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private String name;
private int age;
private String sex;
}
package com.liu.controller;
import com.liu.pojo.User;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
/**
* @author 23862
*/
@Controller
public class UserController {
@RequestMapping("/j1")
@ResponseBody //有该注解就不会走视图解析器,会直接返回一个字符串
public String json1(){
//创建一个对象
User user = new User("小刘",3,"男");
return user.toString();
}
}
在Project Structure的Artifacts选项卡中的WEB-INF目录下创建lib目录并导入Project Libraries下的所有依赖。
配置Tomcat
运行代码,访问http://localhost:8080/j1,发现乱码问题
设置编码格式为utf-8,以及它的返回类型
@Controller
public class UserController {
@RequestMapping(value = "/j1", produces = "application/json;charset=utf-8")
@ResponseBody //有该注解就不会走视图解析器,会直接返回一个字符串
public String json1() throws JsonProcessingException {
//jackson包中有一个ObjectMapper对象,通过它可以生成字符串
ObjectMapper mapper = new ObjectMapper();
//创建一个对象
User user = new User("小刘",3,"男");
mapper.writeValueAsString(user);
return user.toString();
}
}
查看运行结果,乱码问题解决
2.代码优化
乱码统一解决
上一种方法比较麻烦,如果项目中有许多请求则每一个都需要添加,可以通过Spring配置统一指定,这样就不用每次都去处理了。
我们可以在springmvc的配置文件上添加一段消息StringHttpMessageConverter转换配置。
<!--JSON乱码问题配置-->
<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//表示其下的所有方法只会返回JSON字符串
public class UserController {
//@ResponseBody只是配合Controller使用的
@RequestMapping("/j1")
public String json1() throws JsonProcessingException {
//jackson包中有一个ObjectMapper对象,通过它可以生成字符串
ObjectMapper mapper = new ObjectMapper();
//创建一个对象
User user = new User("小刘",3,"男");
//将对象解析称为json格式
String str = mapper.writeValueAsString(user);
//由于@ResponseBody注解,这里会将str转成json格式返回
return str;
}
}
运行结果:
3.测试集合输出
@RequestMapping("/j2")
public String json2() throws JsonProcessingException {
//创建一个Jackson的对象映射器,用来解析数据
ObjectMapper mapper = new ObjectMapper();
//创建一个数组并添加多个对象
List<User> userList = new ArrayList<User>();
User user1 = new User("小刘1",3,"男");
User user2 = new User("小刘2",3,"男");
User user3 = new User("小刘3",3,"男");
User user4 = new User("小刘4",3,"男");
userList.add(user1);
userList.add(user2);
userList.add(user3);
userList.add(user4);
//将对象解析成json格式
String str = mapper.writeValueAsString(userList);
return str;
}
运行结果:
4.输出时间对象
@RequestMapping("/j3")
public String json3() throws JsonProcessingException {
ObjectMapper mapper = new ObjectMapper();
//创建时间对象java.util.Date
Date date = new Date();
//ObjectMapper,时间解析后的默认格式为时间戳
return mapper.writeValueAsString(date);
}
运行结果:
- 默认日期格式会变成一个数字,是1970年1月1日到当前日期的毫秒数
- Jackson默认会把时间转换成timestamps(时间戳)形式
解决方法:取消时间戳格式,自定义时间格式
@RequestMapping("/j3")
public String json3() throws JsonProcessingException {
ObjectMapper mapper = new ObjectMapper();
Date date = new Date();
//自定义日期格式
SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
//ObjectMapper,时间解析后的默认格式为时间戳
return mapper.writeValueAsString(sdf.format(date));
}
运行结果:
5.FastJson
fastjson.jar是阿里开发的一款专门用于Java开发的包,可以方便的实现json对象与JavaBean对象的转换,实现JavaBean对象与json字符串的转换,实现json的转换方法很多,最后的实现结果是一样的。
fastjson的pom依赖,并且手动将jar包添加到lib目录中:
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.60</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字符串之间的相互转化。
@RestController//表示其下的所有方法只会返回JSON字符串
public class UserController {
@RequestMapping("/j4")
public String json4() throws JsonProcessingException {
List<User> userList = new ArrayList<User>();
User user1 = new User("小刘1",3,"男");
User user2 = new User("小刘2",3,"男");
User user3 = new User("小刘3",3,"男");
userList.add(user1);
userList.add(user2);
userList.add(user3);
String string = JSON.toJSONString(userList);
return string;
}
}
运行结果:
@RestController//表示其下的所有方法只会返回JSON字符串
public class UserController {
@RequestMapping("/j4")
public String json4() throws JsonProcessingException {
List<User> userList = new ArrayList<User>();
User user1 = new User("小刘1",3,"男");
User user2 = new User("小刘2",3,"男");
User user3 = new User("小刘3",3,"男");
userList.add(user1);
userList.add(user2);
userList.add(user3);
System.out.println("****** Java对象 转 json字符串 ******");
String str1 = JSON.toJSONString(userList);
System.out.println("JSON.toJSONString(list)==>"+str1);
String str2 = JSON.toJSONString(user1);
System.out.println("JSON.toJSONString(user1)==>"+str2);
System.out.println("\n****** JSON字符串 转 Java对象 ******");
User jp_user1 = JSON.parseObject(str2,User.class);
System.out.println("JSON.parseObject(str2,User.class)==>"+jp_user1);
System.out.println("\n****** JSON对象 转 Java对象 ******");
JSONObject jsonObject1 = (JSONObject) JSON.toJSON(user2);
System.out.println("(JSONObject) JSON.toJSON(user2)==>"+jsonObject1.getString("name"));
System.out.println("\n****** JSON对象 转 Java对象 ******");
User to_java_user = JSON.toJavaObject(jsonObject1, User.class);
System.out.println("JSON.toJavaObject(jsonObject1, User.class)==>"+to_java_user);
return "hello";
}
}
运行结果: