SpringMVC+FastJson+Swagger整合完整示例
一:目錄
一:基礎部分
- 簡介
- fastjson api
二:實戰部分
- Spring MVC + fastjson 整合
- 三:Swagger整合
二:基礎部分
1. FastJson 簡介
Fastjson是一個Java庫,可用於將Java物件轉換為JSON表示。它也可以被用來將一個JSON字串轉換成一個等效的Java物件。在轉換速度上應該是最快的,幾乎成為了專案的標配(在ajax請求和介面開發時一般都會用fastjson而不再使用jackson)。
特性:
- 在伺服器端和android客戶端提供最佳效能
- 提供簡單toJSONString()和parseObject()方法的Java物件轉換為JSON,反之亦然
- 允許存在的無法改變的物件轉換為從JSON
- Java泛型的廣泛支援
- 允許自定義表示物件
- 支援任意複雜的物件(深繼承層次結構和廣泛使用泛型型別)
主要特點:
快速FAST (比其它任何基於Java的解析器和生成器更快,包括jackson)
強大(支援普通JDK類包括任意Java Bean Class、Collection、Map、Date或enum)
零依賴(沒有依賴其它任何類庫除了JDK)
支援註解
2. fastjson api
Fastjson API入口類是com.alibaba.fastjson.JSON,常用的序列化操作都可以在JSON類上的靜態方法直接完成。
// 把JSON文字parse為JSONObject或者JSONArray
public static final Object parse(String text);
// 把JSON文字parse成JSONObject
public static final JSONObject parseObject(String text);
// 把JSON文字parse為JavaBean
public static final <T> T parseObject(String text, Class<T> clazz);
// 把JSON文字parse成JSONArray
public static final JSONArray parseArray(String text);
// 把JSON文字parse成JavaBean集合
public static final <T> List<T> parseArray(String text, Class<T> clazz);
// 將JavaBean序列化為JSON文字
public static final String toJSONString(Object object);
// 將JavaBean序列化為帶格式的JSON文字
public static final String toJSONString(Object object, boolean prettyFormat);
// 將JavaBean轉換為JSONObject或者JSONArray
public static final Object toJSON(Object javaObject);
JSONArray:相當於List<Object>
JSONObject:相當於Map<String, Object>
SerializeConfig: 是對序列化過程中一些序列化過程的特殊配置, 如對一些欄位進行格式處理(日期、列舉等)
SerializeWriter:相當於StringBuffer
SerializerFeature屬性 :
QuoteFieldNames 輸出key時是否使用雙引號,預設為true
UseSingleQuotes 使用單引號而不是雙引號,預設為false
WriteMapNullValue 是否輸出值為null的欄位,預設為false
WriteEnumUsingToString Enum輸出name()或者original,預設為false
UseISO8601DateFormat Date使用ISO8601格式輸出,預設為false
WriteNullListAsEmpty List欄位如果為null,輸出為[],而非null
WriteNullStringAsEmpty 字元型別欄位如果為null,輸出為”“,而非null
WriteNullNumberAsZero 數值欄位如果為null,輸出為0,而非null
WriteNullBooleanAsFalse Boolean欄位如果為null,輸出為false,而非null
SkipTransientField 如果是true,類中的Get方法對應的Field是transient,序列化時將會被忽略。預設為true
SortField 按欄位名稱排序後輸出。預設為false
WriteTabAsSpecial 把\t做轉義輸出,預設為false 不推薦
PrettyFormat 結果是否格式化,預設為false
WriteClassName 序列化時寫入型別資訊,預設為false。反序列化是需用到
DisableCircularReferenceDetect 消除對同一物件迴圈引用的問題,預設為false
WriteSlashAsSpecial 對斜槓’/’進行轉義
BrowserCompatible 將中文都會序列化為\uXXXX格式,位元組數會多一些,但是能相容IE 6,預設為false
WriteDateUseDateFormat 全域性修改日期格式,預設為false。JSON.DEFFAULT_DATE_FORMAT = “yyyy-MM-dd”;JSON.toJSONString(obj, SerializerFeature.WriteDateUseDateFormat);
DisableCheckSpecialChar 一個物件的字串屬性中如果有特殊字元如雙引號,將會在轉成json時帶有反斜槓轉移符。如果不需要轉義,可以使用這個屬性。預設為false
NotWriteRootClassName 含義
BeanToArray 將物件轉為array輸出
WriteNonStringKeyAsString
NotWriteDefaultValue
BrowserSecure
IgnoreNonFieldGetter
WriteEnumUsingName
三:實戰部分
1、pom.xml 中引入spring mvc、 fastjson 依賴
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.mengdee</groupId>
<artifactId>platform-springmvc-webapp</artifactId>
<packaging>war</packaging>
<version>0.0.1-SNAPSHOT</version>
<name>platform-springmvc-webapp Maven Webapp</name>
<url>http://maven.apache.org</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<junit.version>3.8.1</junit.version>
<log4j.version>2.5</log4j.version>
<jstl.version>1.2</jstl.version>
<spring.version>4.2.3.RELEASE</spring.version>
<fastjson.version>1.2.32</fastjson.version>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>3.8.1</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>jstl</artifactId>
<version>${jstl.version}</version>
</dependency>
<!-- springframework -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context-support</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>${fastjson.version}</version>
</dependency>
</dependencies>
<!-- 使用aliyun映象 -->
<repositories>
<repository>
<id>aliyun</id>
<name>aliyun</name>
<url>http://maven.aliyun.com/nexus/content/groups/public</url>
</repository>
</repositories>
<build>
<finalName>platform-springmvc-webapp</finalName>
</build>
</project>
2、 配置web.xml
<!DOCTYPE web-app PUBLIC
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd" >
<web-app>
<display-name>Archetype Created Web Application</display-name>
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:conf/spring/spring-*.xml</param-value>
</context-param>
<listener>
<description>Spring監聽器</description>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<servlet>
<servlet-name>spring-mvc</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/spring-servlet.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>spring-mvc</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
<filter>
<filter-name>characterEncodingFilter</filter-name>
<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
<init-param>
<param-name>encoding</param-name>
<param-value>UTF-8</param-value>
</init-param>
<init-param>
<param-name>forceEncoding</param-name>
<param-value>true</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>characterEncodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
<welcome-file-list>
<welcome-file>/index.jsp</welcome-file>
</welcome-file-list>
<error-page>
<error-code>404</error-code>
<location>/index.jsp</location>
</error-page>
</web-app>
3、 配置spring-servlet.xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:p="http://www.springframework.org/schema/p"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-4.2.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc-4.2.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-4.2.xsd">
<context:component-scan base-package="com.mengdee.manage.controller" />
<bean id="ViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value="/"></property> <!-- 檢視檔案的字首 -->
<property name="suffix" value=".jsp"></property> <!-- 檢視檔案的字尾名 -->
<!-- view是用什麼顯示,這裡是jsp,還可以用velocity之類的 -->
<property name="viewClass" value="org.springframework.web.servlet.view.JstlView"></property>
</bean>
<!-- 啟動Spring MVC的註解功能,完成請求和註解POJO的對映 -->
<mvc:annotation-driven>
<mvc:message-converters register-defaults="true">
<!-- 配置Fastjson 替換原來的jackson支援 -->
<bean class="com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter">
<property name="supportedMediaTypes">
<list>
<value>text/html;charset=UTF-8</value>
<value>application/json</value>
</list>
</property>
<property name="features">
<list>
<value>QuoteFieldNames</value> <!-- 輸出key時是否使用雙引號,預設為true -->
<value>WriteMapNullValue</value> <!-- 是否輸出值為null的欄位,預設為false -->
<!--
<value>DisableCircularReferenceDetect</value>
<value>WriteDateUseDateFormat</value>
<value>WriteNullStringAsEmpty</value> 字元型別欄位如果為null,輸出為"",而非null
<value>WriteNullNumberAsZero</value> 數值欄位如果為null,輸出為0,而非null
<value>WriteNullBooleanAsFalse</value> Boolean欄位如果為null,輸出為false,而非null
<value>WriteNullListAsEmpty</value> List欄位如果為null,輸出為[],而非null
-->
</list>
</property>
</bean>
</mvc:message-converters>
</mvc:annotation-driven>
</beans>
4、Java
Education:學歷(列舉類)
package com.mengdee.manage.entity;
import java.util.HashMap;
import java.util.Map;
/**
* 學歷
* @author Administrator
*
*/
public enum Education {
KINDERGARTEN("幼兒園", 1),
ELEMENTARY("小學", 2),
JUNIOR_MIDDLE("初級中學", 3),
SENIOR_MIDDLE("高階中學", 4),
UNIVERSITY("大學", 5),
COLLEGE("學院", 6);
private static final Map<Integer, Education> EDUCATION_MAP = new HashMap<Integer, Education>();
static {
for (Education education : Education.values()) {
EDUCATION_MAP.put(education.getIndex(), education);
}
}
private String text;
private int index;
private Education(String text, int index) {
this.text = text;
this.index = index;
}
public String getText() {
return text;
}
public void setText(String text) {
this.text = text;
}
public int getIndex() {
return index;
}
public void setIndex(int index) {
this.index = index;
}
public static Education getEnum(Integer index) {
return EDUCATION_MAP.get(index);
}
}
Person:
package com.mengdee.manage.entity;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Map;
import com.alibaba.fastjson.annotation.JSONField;
public class Person {
private Long id;
private String name;
private byte gender; // 性別 1:男 2:女
private short age; // 年齡
private long salary; // 薪水
private double weight; // 體重
private char level; // 評級
private boolean adult; // 是否成年人
private Date birthday; // 生日
private Education education;// 學歷
private String[] hobbies; // 愛好
private List<Dog> dogs; // 寵物狗
private Map<String, Object> address; // 住址
// 使用註解控制是否要序列化
@JSONField(serialize = false)
private List<Object> obj = new ArrayList<>();
public Person() {
}
public Person(Long id, String name, byte gender, short age, long salary, double weight, char level, boolean adult,
Date birthday, String[] hobbies, List<Dog> dogs, Map<String, Object> address) {
super();
this.id = id;
this.name = name;
this.gender = gender;
this.age = age;
this.salary = salary;
this.weight = weight;
this.level = level;
this.adult = adult;
this.birthday = birthday;
this.hobbies = hobbies;
this.dogs = dogs;
this.address = address;
}
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public byte getGender() {
return gender;
}
public void setGender(byte gender) {
this.gender = gender;
}
public short getAge() {
return age;
}
public void setAge(short age) {
this.age = age;
}
public long getSalary() {
return salary;
}
public void setSalary(long salary) {
this.salary = salary;
}
public double getWeight() {
return weight;
}
public void setWeight(double weight) {
this.weight = weight;
}
public char getLevel() {
return level;
}
public void setLevel(char level) {
this.level = level;
}
public boolean isAdult() {
return adult;
}
public void setAdult(boolean adult) {
this.adult = adult;
}
public Date getBirthday() {
return birthday;
}
public void setBirthday(Date birthday) {
this.birthday = birthday;
}
// 處理序列化列舉型別,預設的值是序列化列舉值字串,而不是列舉繫結的索引或者文字
@JSONField(name = "edu")
public int getEdu(){
return education.getIndex();
}
@JSONField(name = "edu")
public void setEdu(int index){
this.education = Education.getEnum(index);
}
@JSONField(serialize = false)
public Education getEducation() {
return education;
}
@JSONField(serialize = false)
public void setEducation(Education education) {
this.education = education;
}
public String[] getHobbies() {
return hobbies;
}
public void setHobbies(String[] hobbies) {
this.hobbies = hobbies;
}
public List<Dog> getDogs() {
return dogs;
}
public void setDogs(List<Dog> dogs) {
this.dogs = dogs;
}
public Map<String, Object> getAddress() {
return address;
}
public void setAddress(Map<String, Object> address) {
this.address = address;
}
}
TestController
package com.mengdee.manage.controller;
import java.text.DecimalFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONArray;
import com.alibaba.fastjson.serializer.DoubleSerializer;
import com.alibaba.fastjson.serializer.SerializeConfig;
import com.alibaba.fastjson.serializer.SimpleDateFormatSerializer;
import com.mengdee.manage.entity.Address;
import com.mengdee.manage.entity.Dog;
import com.mengdee.manage.entity.Education;
import com.mengdee.manage.entity.Person;
@Controller
public class TestController {
private static SerializeConfig serializeConfig = new SerializeConfig();
static {
serializeConfig.put(Date.class, new SimpleDateFormatSerializer("yyyy-MM-dd HH:mm:ss"));
serializeConfig.put(Double.class, new DoubleSerializer(new DecimalFormat("0.00")));
}
@RequestMapping("/index")
public String index(){
return "index";
}
// javabean to object
@RequestMapping("/json")
@ResponseBody
public Object json(){
Person person = new Person();
person.setId(1L);
person.setName("mengdee");
person.setAge((short) 18);
//
/*
{
"birthday": null,
"weight": 0,
"dogs": null,
"adult": false,
"hobbies": null,
"education": null,
"id": 1,
"level": "",
"address": null,
"age": 18,
"name": "mengdee",
"gender": 0,
"salary": 0
}
*/
Object personJson = JSON.toJSON(person);
return personJson;
}
// javabean to string
@RequestMapping("/json2")
@ResponseBody
public String json2(){
Person person = new Person();
person.setId(1L);
person.setName("mengdee");
person.setAge((short) 18);
// 使用該方式值為null的經測試不出來,已經配置了<value>WriteMapNullValue</value>
// "{"adult":false,"age":18,"gender":0,"id":1,"level":"","name":"mengdee","salary":0,"weight":0.0}"
String jsonString = JSON.toJSONString(person);
return jsonString;
}
@RequestMapping("/json3")
@ResponseBody
public Object json3(){
Person person = new Person();
person.setId(1L);
person.setName("mengdee");
person.setAge((short) 18);
person.setBirthday(new Date());
Object personJson = JSON.toJSON(person); // JSON.toJSON(person)預設是毫秒數"birthday":1495073314780,
// 使用serializeConfig序列號配置對日期格式化
// "{"birthday":"2017-05-18 10:19:55","weight":0.0,"adult":false,"id":1,"level":"","age":18,"name":"mengdee","gender":0,"salary":0}"
String jsonString = JSON.toJSONString(personJson, serializeConfig);
return jsonString;
}
@RequestMapping("/json4")
@ResponseBody
public Object json4(){
Person person = new Person();
person.setId(1L);
person.setName("mengdee");
person.setAge((short) 18);
person.setBirthday(new Date());
person.setEducation(Education.UNIVERSITY); // 列舉
String[] hobbies = {"讀書", "旅遊"};
person.setHobbies(hobbies);
Dog dog1 = new Dog(1L, "dog1", (short)1);
Dog dog2 = new Dog(2L, "dog2", (short)2);
List<Dog> dogs = new ArrayList<>();
dogs.add(dog1);
dogs.add(dog2);
person.setDogs(dogs);
Address address1 = new Address(1l, "上海浦東新區");
Address address2 = new Address(2l, "上海寶山區");
Map<String, Object> addressMap = new HashMap<>();
addressMap.put(address1.getId() + "", address1);
addressMap.put(address2.getId() + "", address2);
person.setAddress(addressMap);
Object personJson = JSON.toJSON(person);
return personJson;
}
@RequestMapping("/json5")
@ResponseBody
public String json5(){
Dog dog1 = new Dog(1L, "dog1", (short)1);
Dog dog2 = new Dog(2L, "dog2", (short)2);
List<Dog> dogs = new ArrayList<>();
dogs.add(dog1);
dogs.add(dog2);
// List<T> -> JSON
String jsonString = JSON.toJSONString(dogs, false);
System.out.println(jsonString);
// JSON -> List<T>
List<Dog> parseArray = JSON.parseArray(jsonString, Dog.class);
for (Dog dog : parseArray) {
System.out.println(dog);
}
Map<String,Dog> map = new HashMap<String, Dog>();
map.put("dog1",new Dog(1L, "dog1", (short)1));
map.put("dog2",new Dog(2L, "dog2", (short)2));
map.put("dog3",new Dog(3L, "dog3", (short)3));
// Map -> JSON
String mapJsonString = JSON.toJSONString(map,true);
System.out.println(mapJsonString);
// JSON -> Map
@SuppressWarnings("unchecked")
Map<String,Dog> map1 = (Map<String,Dog>)JSON.parse(mapJsonString);
for (String key : map1.keySet()) {
System.out.println(key + ":" + map1.get(key));
}
// Array -> JSON
String[] hobbies = {"a","b","c"};
String hobbiesString = JSON.toJSONString(hobbies,true);
System.out.println(hobbies);
// JSON -> Array
JSONArray jsonArray = JSON.parseArray(hobbiesString);
for (Object o : jsonArray) {
System.out.println(o);
}
System.out.println(jsonArray);
return jsonString;
}
}
四:Swagger整合
第一步:引入相關依賴
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.6.1</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.6.6</version>
</dependency>
第二步:Swagger資訊配置
SwaggerConfig.java
@Configuration
@EnableWebMvc
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket customDocket() {
Docket docket = new Docket(DocumentationType.SWAGGER_2);
docket.apiInfo(apiInfo());
docket.select().apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class));
docket.select().paths(PathSelectors.regex("/api/.*")).build();
return docket;
}
private ApiInfo apiInfo() {
Contact contact = new Contact("小明", "http://www.baidu.com", "[email protected]");
return new ApiInfo("API介面", //大標題 title
"API介面", //小標題
"0.0.1", //版本
"www.baidu.com",//termsOfServiceUrl
contact,//作者
"API介面",//連結顯示文字
"http://www.baidu.com"//網站連結
);
}
}
注意:因SwaggerConfig這個類配置了註解,所以這個類必須被掃描到,即該類一定包含在context:component-scan中。
第三步:在類、方法、引數上使用註解
@Controller
@RequestMapping("/api/v1")
@Api(description = "API介面")
public class ApiController {
@ApiOperation(value = "使用者登入", notes = "使用者登入介面")
@ApiResponses({
@ApiResponse(code = 0, message = "success"),
@ApiResponse(code = 10001, message = "使用者名稱錯誤", response = IllegalArgumentException.class),
@ApiResponse(code = 10002, message = "密碼錯誤")
})
@RequestMapping(value = "/user/login", method = RequestMethod.POST, produces = {"application/json;charset=UTF-8;"})
@ResponseBody
public String login(@ApiParam(name = "username", value = "使用者名稱", required = true) @RequestParam String username,
@ApiParam(name = "password", value = "密碼", required = true) @RequestParam String password){
return "{'username':'" + username + "', 'password':'" + password + "'}";
}
@ApiImplicitParams({
@ApiImplicitParam(paramType = "header", name = "phone", dataType = "String", required = true, value = "手機號"),
@ApiImplicitParam(paramType = "query", name = "nickname", dataType = "String", required = true, value = "nickname", defaultValue = "雙擊666"),
@ApiImplicitParam(paramType = "path", name = "platform", dataType = "String", required = true, value = "平臺", defaultValue = "PC"),
@ApiImplicitParam(paramType = "body", name = "password", dataType = "String", required = true, value = "密碼")
})
@RequestMapping(value = "/{platform}/user/regist", method = RequestMethod.POST, produces = {"application/json;charset=UTF-8;"})
@ResponseBody
public String regist(@RequestHeader String phone, @RequestParam String nickname, @PathVariable String platform, @RequestBody String password){
return "{'username':'" + phone + "', 'nickname':'" + nickname + "', 'platform': '" + platform + "', 'password':'"+password+"'}";
}
@RequestMapping(value = "/user/list", m