ssm中如何返回json

SSM框架中实现JSON返回的完整指南

在SSM（Spring + Spring MVC + MyBatis）框架开发中，前后端分离架构已成为主流趋势，而JSON作为前后端数据交互的标准格式，其重要性不言而喻，本文将详细介绍在SSM框架中如何配置和实现Controller层返回JSON数据，包括传统配置方式和现代注解方式，以及常见问题的解决方案。

返回JSON的基本原理

Spring MVC框架通过HttpMessageConverter接口来处理HTTP请求和响应的转换，当Controller方法返回一个对象时，Spring MVC会自动寻找合适的HttpMessageConverter将对象序列化为JSON格式并写入响应体中，默认情况下，Spring MVC使用MappingJackson2HttpMessageConverter来处理JSON转换，这依赖于Jackson库。

配置方式

传统XML配置方式

在Spring MVC的配置文件（如spring-mvc.xml）中，需要配置<mvc:annotation-driven>标签，它会自动注册MappingJackson2HttpMessageConverter：

<mvc:annotation-driven/>

确保项目中包含Jackson依赖：

<!-- Jackson依赖 -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.13.0</version>
</dependency>

Java配置方式

使用Java配置时,可以通过@EnableWebMvc注解和WebMvcConfigurer接口来实现：

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
        converter.setObjectMapper(new ObjectMapper());
        converters.add(converter);
    }
}

Controller层实现

使用@ResponseBody注解

在Controller方法上添加@ResponseBody注解，表示该方法返回的对象直接写入响应体，不进行视图解析：

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

使用@RestController注解

如果整个Controller都只返回JSON数据,可以使用@RestController注解，它相当于@Controller和@ResponseBody的组合：

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

返回统一响应格式

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

@RestController
@RequestMapping("/api")
public class ApiController {
    @GetMapping("/user/{id}")
    public ResponseEntity<Result<User>> getUserById(@PathVariable("id") Long id) {
        User user = userService.getUserById(id);
        Result<User> result = new Result<>(200, "success", user);
        return ResponseEntity.ok(result);
    }
}
// 统一响应格式类
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Result<T> {
    private int code;
    private String message;
    private T data;
}

高级配置

自定义JSON序列化

可以通过配置ObjectMapper来自定义JSON序列化行为：

@Configuration
public class JacksonConfig {
    @Bean
    public ObjectMapper objectMapper() {
        ObjectMapper mapper = new ObjectMapper();
        // 忽略未知属性
        mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        // 禁用默认日期格式
        mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
        // 自定义日期格式
        mapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
        return mapper;
    }
}

处理循环引用

在实体类中可能存在循环引用问题,可以通过以下方式解决：

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

异常处理

统一异常处理可以返回标准化的JSON错误响应：

@ControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public ResponseEntity<Result<String>> handleException(Exception e) {
        Result<String> result = new Result<>(500, e.getMessage(), null);
        return ResponseEntity.status(500).body(result);
    }
}

常见问题与解决方案

404 Not Found

确保请求路径正确,且Controller和方法映射正确配置。

返回JSON为null或空

检查实体类是否正确,以及是否配置了合适的序列化规则。

日期格式问题

通过配置ObjectMapper的日期格式来解决：

objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd"));

中文乱码

确保Spring MVC配置中设置了正确的字符编码：

<mvc:annotation-driven>
    <mvc:message-converters>
        <bean class="org.springframework.http.converter.StringHttpMessageConverter">
            <property name="supportedMediaTypes">
                <list>
                    <value>text/html;charset=UTF-8</value>
                    <value>application/json;charset=UTF-8</value>
                </list>
            </property>
        </bean>
    </mvc:message-converters>
</mvc:annotation-driven>

在SSM框架中实现JSON返回主要通过配置MappingJackson2HttpMessageConverter和使用@ResponseBody或@RestController注解，通过合理的配置和异常处理，可以构建出健壮的前后端分离API接口，随着Spring Boot的普及，许多配置已经简化，但理解其底层原理对于解决复杂问题仍然非常重要，这些技术，将能更好地支持现代Web应用的开发需求。