（SpringMVC）Controller返回JSON数据
文章目录
- Controller返回JSON数据
- 1. 测试使用
- 2. 代码优化
- 3. 测试集合输出
- 4. 输出时间对象
- 5. 抽取为工具类
- 6. FastJson
Controller返回JSON数据
1. 测试使用
这里使用Jackson解析工具用来解析json，这种工具有很多，比如阿里的fastjson
使用它需要导入相应的依赖
<dependency>
<groupId>com.fasterxml.jackson.coregroupId>
<artifactId>jackson-databindartifactId>
<version>2.9.8version>
dependency>
随便编写一个实体类
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private String name;
private int age;
private String sex;
}
编写对应的控制器Controller
@Controller
public class UserController {
@RequestMapping("/j1")
@ResponseBody
public String json1() throws JsonProcessingException {
//创建一个jackson的对象映射器，用来解析数据
ObjectMapper mapper = new ObjectMapper();
//创建一个User对象
User user = new User("伊泽瑞尔",18,"男");
//将对象转换为json格式
String str = mapper.writeValueAsString(user);
//由于@ResponseBody注解，这里会将str转成json格式返回；十分方便
return str;
}
}
测试
这里出现了乱码,设置一下他的编码格式为utf-8，以及它返回的类型；
通过@RequestMaping的produces属性来实现，修改下代码
//produces:指定响应体返回类型和编码
@RequestMapping(value = "/json1",produces = "application/json;charset=utf-8")
解决
2. 代码优化
乱码统一解决
上述解决乱码问题太过麻烦，每一个都要解决，可以通过springmvc配置统一解决
在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 。
//@Controller
@RestController
public class UserController {
@RequestMapping("/j1")
// @ResponseBody
public String json1() throws JsonProcessingException {
//创建一个jackson的对象映射器，用来解析数据
ObjectMapper mapper = new ObjectMapper();
//创建一个User对象
User user = new User("伊泽瑞尔",18,"男");
//将对象转换为json格式
String str = mapper.writeValueAsString(user);
//由于@ResponseBody注解，这里会将str转成json格式返回；十分方便
return str;
}
}
3. 测试集合输出
添加一个方法
@RequestMapping("/j2")
public String json2() throws JsonProcessingException {
//创建一个jackson的对象映射器，用来解析数据
ObjectMapper mapper = new ObjectMapper();
//创建一个集合存放User对象
List<User> userList = new ArrayList<User>();
User user1 = new User("伊泽瑞尔1",18,"男");
User user2 = new User("伊泽瑞尔2",18,"男");
User user3 = new User("伊泽瑞尔3",18,"男");
User user4 = new User("伊泽瑞尔4",18,"男");
userList.add(user1);
userList.add(user2);
userList.add(user3);
userList.add(user4);
//将对象转换为json格式
String str = mapper.writeValueAsString(userList);
//由于@ResponseBody注解，这里会将str转成json格式返回；十分方便
return str;
}
测试
4. 输出时间对象
@RequestMapping("/j3")
public String json3() throws JsonProcessingException {
//创建一个jackson的对象映射器，用来解析数据
ObjectMapper mapper = new ObjectMapper();
//创建一个日期对象
Date date = new Date();
//自定义日期格式对象
SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
//将对象转换为json格式
String str = mapper.writeValueAsString(sdf.format(date));
//由于@ResponseBody注解，这里会将str转成json格式返回；十分方便
return str;
}
5. 抽取为工具类
如果要经常使用的话，这样是比较麻烦的，我们可以将这些代码封装到一个工具类中；
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){
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;
}
}
修改原先代码
//@Controller
@RestController
public class UserController {
@RequestMapping("/j1")
// @ResponseBody
public String json1() throws JsonProcessingException {
User user = new User("伊泽瑞尔",18,"男");
return JsonUtils.getJson(user);
}
@RequestMapping("/j2")
public String json2() throws JsonProcessingException {
//创建一个集合存放User对象
List<User> userList = new ArrayList<User>();
User user1 = new User("伊泽瑞尔1",18,"男");
User user2 = new User("伊泽瑞尔2",18,"男");
User user3 = new User("伊泽瑞尔3",18,"男");
User user4 = new User("伊泽瑞尔4",18,"男");
userList.add(user1);
userList.add(user2);
userList.add(user3);
userList.add(user4);
//由于@ResponseBody注解，这里会将str转成json格式返回；十分方便
return JsonUtils.getJson(userList);
}
@RequestMapping("/j3")
public String json3() throws JsonProcessingException {
return JsonUtils.getJson(new Date(),"yyyy-MM-dd HH:mm:ss");
}
}
测试正常输出
6. FastJson
fastjson.jar是阿里开发的一款专门用于Java开发的包，可以方便的实现json对象与JavaBean对象的转换，实现JavaBean对象与json字符串的转换，实现json对象与json字符串的转换。实现json的转换方法很多，最后的实现结果都是一样的。
fastjson 的 pom依赖
<dependency>
<groupId>com.alibabagroupId>
<artifactId>fastjsonartifactId>
<version>1.2.60version>
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字符串之间的相互转化。
代码测试
public class FastJsonDemo {
public static void main(String[] args) {
//创建一个对象
User user1 = new User("伊泽瑞尔1",18,"男");
User user2 = new User("伊泽瑞尔2",18,"男");
User user3 = new User("伊泽瑞尔3",18,"男");
User user4 = new User("伊泽瑞尔4",18,"男");
List<User> list = new ArrayList<User>();
list.add(user1);
list.add(user2);
list.add(user3);
list.add(user4);
System.out.println("*******Java对象 转 JSON字符串*******");
String str1 = JSON.toJSONString(list);
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****** Java对象 转 JSON对象 ******");
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);
}
}