自定义HttpMessageConverter实战解析

自定义HttpMessageConverter实战解析

在Spring框架中，HttpMessageConverter是一个用于转换HTTP请求和响应的接口。本文将通过一个具体的实例，详细解析如何创建和注册一个自定义的HttpMessageConverter。

创建自定义转换器

我们首先定义一个Report类，该类将用于表示消息体。假设消息体的第一行是报告名称，其余部分是报告内容。

public class Report {
    private int id;
    private String reportName;
    private String content;
    // 省略getters和setters
}

接着，我们创建一个继承自AbstractHttpMessageConverter<Report>的转换器ReportConverter，用于将消息体转换为Report对象。

public class ReportConverter extends AbstractHttpMessageConverter<Report> {
    public ReportConverter() {
        super(new MediaType("text", "report"));
    }
    // 支持的类检查
    protected boolean supports(Class<?> clazz) {
        return Report.class.isAssignableFrom(clazz);
    }
    // 读取内部实现
    protected Report readInternal(Class<? extends Report> clazz, HttpInputMessage inputMessage) {
        // 省略具体实现
    }
    // 写入内部实现
    protected void writeInternal(Report report, HttpOutputMessage outputMessage) {
        // 省略具体实现
    }
    // 将InputStream转换为String的方法
    private static String toString(InputStream inputStream) {
        // 省略具体实现
    }
}

控制器使用转换器

然后，我们定义一个ReportController控制器，使用@RequestBody注解来接收转换后的Report对象，并使用@ResponseBody注解返回响应。

@Controller
public class ReportController {
    private List<Report> reports = new ArrayList<>();
    @RequestMapping(value = "/reports", method = RequestMethod.POST, consumes = "text/report")
    @ResponseBody
    public String handleRequest(@RequestBody Report report) {
        // 省略具体实现
    }
    @RequestMapping(value = "/reports/{id}", method = RequestMethod.GET)
    @ResponseBody
    public Report reportById(@PathVariable("id") int reportId) {
        // 省略具体实现
    }
}

注册转换器

最后，我们需要在Spring的配置类中注册我们的ReportConverter。

@EnableWebMvc
@ComponentScan
public class AppConfig extends WebMvcConfigurerAdapter {
    @Override
    public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        converters.add(new ReportConverter());
    }
}

编写JUnit测试

使用JUnit和Spring的测试框架，我们可以编写测试用例来验证我们的转换器是否按预期工作。

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = AppConfig.class)
public class ReportTests {
    // 省略具体实现
    @Test
    public void testNewReport() throws Exception {
        // 省略具体实现
    }
    private String createTestReport() {
        return "dummy report name\ndummy report content.";
    }
}

输出结果

测试运行后，我们可以看到控制台输出了创建新报告和通过ID获取报告的详细信息。

示例项目

本示例项目使用了以下依赖和技术：

• spring-webmvc 4.2.4.RELEASE
• spring-test 4.2.4.RELEASE
• javax.servlet-api 3.0.1
• junit 4.12
• JDK 1.8
• Maven 3.3.9

通过本文的分析，你应该对如何在Spring框架中创建和使用自定义的HttpMessageConverter有了更深入的理解。希望这个实例能够帮助你在实际开发中更好地利用Spring的强大功能。