Spring MVC 是 Spring Framework 中負責 Web 層的重要模組。當需要向前端回傳 JSON 時,可視專案環境選擇不同的實作方式。
這是 Spring 2 時代常見的做法,通常會在設定檔中宣告 MappingJacksonJsonView 或 MappingJackson2JsonView,讓 Controller 回傳模型資料後,由檢視層負責轉換成 JSON。
這種方式需要搭配 Jackson 相關套件,適合較早的 Spring MVC 專案。
另一種常見做法是先將物件轉成 JSON 字串,再透過 Response 輸出。常用工具包括 Jackson、Fastjson、Gson。
public class JsonUtil {
private static Gson gson = new Gson();
public static String toJson(Object src) {
if (src == null) {
return gson.toJson(JsonNull.INSTANCE);
}
return gson.toJson(src);
}
}
取得 response 的 OutputStream 或 Writer 後,即可直接輸出 JSON 字串。
Spring MVC 3 之後,最常見的方式是在方法上加上 ResponseBody,讓 Spring 自動將回傳物件序列化為 JSON。
@ResponseBody
@RequestMapping("/list")
public Object list(ModelMap modelMap) {
// 查詢資料後回傳
return page.getResult();
}
使用這種方式時,通常需要加入 Jackson 套件。若在 springmvc-servlet.xml 中使用 mvc:annotation-driven,Spring 會依版本自動注入對應的 HandlerAdapter 與訊息轉換器。
若是手動設定 RequestMappingHandlerAdapter,也可以自行註冊 MappingJacksonHttpMessageConverter,讓 JSON 轉換正常運作。
整體來看,ResponseBody 的寫法最直覺,也最符合現代 Spring MVC 開發習慣。