SSM框架下高效返回JSON数据的完整指南**
在基于SSM（Spring + Spring MVC + MyBatis）框架开发Web应用时，前后端分离已成为主流趋势，前端页面通过AJAX请求从后端获取JSON格式的数据进行动态渲染，后端如何高效、规范地返回JSON数据显得尤为重要，本文将详细介绍在SSM框架中实现JSON数据返回的多种方法及最佳实践。
为什么需要返回JSON？
在SSM项目中,返回JSON数据主要用于：
- 前后端分离：前端独立开发，通过API与后端交互，JSON是轻量级且通用的数据交换格式。
- AJAX请求：前端异步请求数据，后端返回JSON，页面无需刷新即可更新内容。
- 移动端接口：为移动APP提供数据接口，JSON也是移动端常用的数据格式。
SSM中返回JSON的常用方法
在SSM中,Spring MVC为我们提供了非常便捷的方式来返回JSON数据，以下是几种最常用的方法：
使用@ResponseBody注解（推荐，最常用）
这是Spring MVC中处理JSON返回最直接、最常用的方式。@ResponseBody注解可以将控制器方法的返回对象直接转换为JSON格式，并写入到HTTP响应体的中。
实现步骤：
-
引入JSON处理库依赖： 我们会使用Jackson或Gson，Spring MVC默认集成Jackson，在
pom.xml中添加Jackson依赖：<dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.13.0</version> <!-- 使用合适的版本 --> </dependency> -
配置Spring MVC： 确保Spring MVC的配置文件中已经启用了注解驱动，
<mvc:annotation-driven/>会自动配置好消息转换器（包括Jackson的MappingJackson2HttpMessageConverter），用于处理JSON的转换。<!-- 在spring-mvc.xml中 --> <mvc:annotation-driven/>
-
在Controller方法上使用
@ResponseBody： 可以标注在Controller方法上，也可以标注在整个Controller类上（表示该类所有方法都返回响应体，而非视图名）。示例代码：
import com.example.entity.User; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.ResponseBody; @Controller public class UserController { @GetMapping("/getUser") @ResponseBody // 表示此方法返回的不是视图名，而是直接写入响应体的数据 public User getUser() { User user = new User(1L, "张三", "zhangsan@example.com"); return user; // Spring MVC会自动将User对象转换为JSON字符串 } @GetMapping("/getUsers") @ResponseBody public List<User> getUsers() { // 假设userService.listUsers()返回List<User> return userService.listUsers(); } @GetMapping("/getMap") @ResponseBody public Map<String, Object> getMap() { Map<String, Object> map = new HashMap<>(); map.put("code", 200); map.put("message", "success"); map.put("data", new User(2L, "李四", "lisi@example.com")); return map; } }当访问
/getUser时，浏览器会收到类似{"id":1,"name":"张三","email":"zhangsan@example.com"}的JSON响应。
返回ResponseEntity对象
ResponseEntity代表了整个HTTP响应，包括状态码、响应头和响应体，使用它可以更灵活地控制响应的各个方面。
示例代码：
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController // @RestController相当于@Controller + @ResponseBody
public class UserControllerWithResponseEntity {
@GetMapping("/getUserWithEntity")
public ResponseEntity<User> getUserWithEntity() {
User user = new User(3L, "王五", "wangwu@example.com");
return ResponseEntity.ok(user); // 设置状态码为200 OK，body为user对象
}
@GetMapping("/notFound")
public ResponseEntity<String> notFound() {
return ResponseEntity.status(HttpStatus.NOT_FOUND).body("用户不存在");
}
}
使用@RestController注解（简化版）
@RestController是Spring 4.0引入的注解，它是一个复合注解，相当于@Controller和@ResponseBody的组合，标注了@RestController的Controller类中的所有方法都会返回JSON格式的响应体，无需再在每个方法上添加@ResponseBody。
这是目前开发RESTful API时最常用的Controller注解。
示例代码：
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class MyRestController {
@GetMapping("/api/hello")
public String hello() {
return "Hello, World!"; // 即使返回String，也会被转换为JSON字符串（带引号）
}
@GetMapping("/api/user")
public User getUserApi() {
return new User(4L, "赵六", "zhaoliu@example.com");
}
}
结合MyBatis返回JSON
MyBatis主要负责数据库操作,它本身不直接处理JSON，但MyBatis查询出的结果（List、对象等）会被Spring MVC的@ResponseBody或@RestController自动转换为JSON。
示例步骤：
-
MyBatis Mapper接口：
public interface UserMapper { List<User> findAllUsers(); User selectUserById(Long id); } -
MyBatis Mapper XML：
<!-- UserMapper.xml --> <select id="findAllUsers" resultType="com.example.entity.User"> SELECT id, name, email FROM users </select> -
Service层：
@Service public class UserService { @Autowired private UserMapper userMapper; public List<User> listUsers() { return userMapper.findAllUsers(); } } -
Controller层（使用
@RestController）：@RestController @RequestMapping("/api/users") public class UserApiController { @Autowired private UserService userService; @GetMapping public List<User> getUsers() { return userService.listUsers(); // MyBatis返回List，Spring MVC转为JSON数组 } }
高级配置与最佳实践
-
统一JSON响应格式： 为了前端处理方便，通常会将所有API的响应格式统一，
{ "code": 200, "message": "操作成功", "data": { /* 实际数据 */ } } 或 { "code": 400, "message": "请求参数错误", "data": null }可以创建一个统一的响应对象,如
Result<T>，然后在Controller中返回这个对象。public class Result<T> { private int code; private String message; private T data; // 构造方法、getter、setter } @RestController public class CommonController { @GetMapping("/commonResult") public Result<String> commonResult() { Result<String> result = new Result<>(); result.setCode(200); result.setMessage("success"); result.setData("这是一个统一响应格式的示例"); return result; } } -
日期格式化： Jackson默认的日期格式可能不符合需求，可以通过
@JsonFormat注解在实体类字段上指定日期格式，或通过全局配置。// 在实体类字段上 @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8") private Date createTime; // 或者在Spring MVC配置中全局配置 /* <mvc:annotation-driven> <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"> <property name="pattern" value="yyyy-MM-dd HH:mm:ss"/> </bean> </property> </bean> </property> </bean> </message-converters> </mvc:annotation-driven> */ -
忽略null字段： 如果希望JSON中不包含值为null的字段，可以在ObjectMapper中配置。
@Configuration public class JacksonConfig { @Bean public ObjectMapper objectMapper() { ObjectMapper objectMapper = new ObjectMapper(); objectMapper
还没有评论，来说两句吧...