ssm怎么返回json数据

SSM框架如何返回JSON数据：从配置到实践的完整指南

在基于SSM（Spring + Spring MVC + MyBatis）框架开发Web应用时，返回JSON数据是前后端分离架构中的常见需求，本文将详细介绍在SSM框架中配置和实现返回JSON数据的完整流程，包括环境配置、Controller编写、常见问题及解决方案。

环境准备与依赖配置

确保项目中已经添加了必要的依赖，在pom.xml中,需要包含以下关键依赖：

<!-- Spring MVC -->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>5.3.20</version>
</dependency>
<!-- JSON处理库（Jackson是Spring MVC默认支持） -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.13.3</version>
</dependency>
<!-- MyBatis -->
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.10</version>
</dependency>
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis-spring</artifactId>
    <version>2.0.7</version>
</dependency>

Spring MVC配置

在Spring的配置文件（如spring-mvc.xml）中,需要开启注解驱动并配置JSON消息转换器：

<!-- 开启注解驱动 -->
<mvc:annotation-driven/>
<!-- 配置JSON转换器 -->
<mvc:annotation-driven>
    <mvc:message-converters>
        <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
            <property name="supportedMediaTypes">
                <list>
                    <value>application/json;charset=UTF-8</value>
                </list>
            </property>
        </bean>
    </mvc:message-converters>
</mvc:annotation-driven>

Controller层实现

基本JSON返回

在Controller方法中，可以直接返回Java对象，Spring MVC会自动将其转换为JSON格式：

@Controller
@RequestMapping("/user")
public class UserController {
    @Autowired
    private UserService userService;
    @GetMapping("/{id}")
    @ResponseBody
    public User getUserById(@PathVariable Integer id) {
        return userService.getUserById(id);
    }
}

关键点：

• 使用@ResponseBody注解标记方法，表示直接返回数据而非视图
• 返回的Java对象会被自动序列化为JSON

返回统一响应格式

实际项目中，通常需要统一的响应格式，包含状态码、消息和数据：

public class Result {
    private int code;
    private String message;
    private Object data;
    // 构造方法、getter和setter省略
}
@Controller
@RequestMapping("/user")
public class UserController {
    @GetMapping("/list")
    @ResponseBody
    public Result getUserList() {
        List<User> users = userService.getAllUsers();
        return new Result(200, "success", users);
    }
}

使用@RestController注解

对于纯API控制器，可以使用@RestController替代@Controller，这样所有方法都会默认添加@ResponseBody：

@RestController
@RequestMapping("/api/user")
public class UserController {
    @GetMapping("/{id}")
    public User getUserById(@PathVariable Integer id) {
        return userService.getUserById(id);
    }
}

MyBatis集成

MyBatis通常与Spring结合使用,通过Mapper接口返回数据：

public interface UserMapper {
    @Select("SELECT * FROM users WHERE id = #{id}")
    User findById(Integer id);
    @Select("SELECT * FROM users")
    List<User> findAll();
}

然后在Service层调用Mapper,Controller返回Service处理的结果：

@Service
public class UserServiceImpl implements UserService {
    @Autowired
    private UserMapper userMapper;
    @Override
    public User getUserById(Integer id) {
        return userMapper.findById(id);
    }
}

常见问题与解决方案

日期格式问题

默认情况下，Jackson会将日期序列化为时间戳,可以通过配置自定义日期格式：

@Configuration
public class JacksonConfig {
    @Bean
    public ObjectMapper objectMapper() {
        ObjectMapper mapper = new ObjectMapper();
        mapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
        return mapper;
    }
}

循环引用问题

实体类之间可能存在双向关联，导致JSON序列化时出现循环引用,可以通过以下方式解决：

@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
public class User {
    private Integer id;
    private String name;
    private List<Order> orders; // 可能导致循环引用
}

忽略某些字段

使用@JsonIgnore注解忽略不需要序列化的字段：

public class User {
    private Integer id;
    private String name;
    @JsonIgnore
    private String password; // 不会被序列化
}

完整示例

下面是一个完整的Controller示例,展示了如何返回不同类型的JSON数据：

@RestController
@RequestMapping("/api")
public class ApiController {
    @Autowired
    private UserService userService;
    // 返回单个对象
    @GetMapping("/user/{id}")
    public Result getUser(@PathVariable Integer id) {
        User user = userService.getUserById(id);
        if (user != null) {
            return new Result(200, "查询成功", user);
        } else {
            return new Result(404, "用户不存在", null);
        }
    }
    // 返回列表
    @GetMapping("/users")
    public Result getUserList() {
        List<User> users = userService.getAllUsers();
        return new Result(200, "查询成功", users);
    }
    // 返回分页数据
    @GetMapping("/users/page")
    public Result getUserPage(@RequestParam(defaultValue = "1") int page,
                            @RequestParam(defaultValue = "10") int size) {
        PageHelper.startPage(page, size);
        List<User> users = userService.getAllUsers();
        PageInfo<User> pageInfo = new PageInfo<>(users);
        return new Result(200, "查询成功", pageInfo);
    }
    // 返回操作结果
    @PostMapping("/user")
    public Result addUser(@RequestBody User user) {
        try {
            userService.addUser(user);
            return new Result(200, "添加成功", null);
        } catch (Exception e) {
            return new Result(500, "添加失败: " + e.getMessage(), null);
        }
    }
}

在SSM框架中返回JSON数据主要涉及以下几个关键点：

1. 添加必要的依赖（尤其是Jackson）
2. 配置Spring MVC的注解驱动和消息转换器
3. 在Controller中使用@ResponseBody或@RestController
4. 设计合理的响应格式（如包含状态码和消息）
5. 处理序列化中的特殊问题（日期格式、循环引用等）

通过以上配置和实现，SSM框架可以灵活地返回各种格式的JSON数据，满足前后端分离架构的需求，随着Spring Boot的普及，这些配置已经大大简化，但理解SSM框架下的JSON返回机制对于维护老项目和理解Spring MVC仍然非常有价值。