最近在一個(gè)項(xiàng)目組里面寫接口，因?yàn)楸救耸茿ndorid起家的（手動哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈）棍鳖，所以對接口特別熟悉（又愛又恨）撒璧，現(xiàn)在將如何寫接口的方法貼出來，讓廣大的客戶端開發(fā)者不在去看后臺同事的眼色了续镇，畢竟咋也寫了，哈哈哈销部，順便說一句摸航。。舅桩。酱虎。服務(wù)端、客戶端都會寫才是以后的發(fā)展趨勢（手動哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈）擂涛，話不多說读串，我們開始吧！Ｈ雎琛恢暖！
1.需要寫接口，那么我們就需要一個(gè)適合自己的后臺框架狰右，現(xiàn)在主流的框架有Spring MVC杰捂、JFinal、以及一些好多個(gè)框架結(jié)合起來的新框架棋蚌，這些都不重要嫁佳，因?yàn)槲覀兊亩饶锬莾憾加心匕ざ樱眠^來用就可以了，主要還是看代碼脱拼，嘿嘿瞒瘸。這篇文章用的是springMVC。其余框架請自行百度學(xué)習(xí)
2.定義接口返回?cái)?shù)據(jù)的格式熄浓，這個(gè)很重要的情臭，因?yàn)檫@個(gè)東東如果設(shè)計(jì)好的話就會避免客戶端的同事去埋怨你，所有最好和客戶端的同事商量一下再做決定赌蔑。
附上我們的數(shù)據(jù)格式
/**
* @ClassName: JsonBean
* @author Liu_xg
* @date 2018年5月7日
* @Description: TODO
*/
public class JsonBeanUtils {
/**{
"count": 49416,
"code": 0,
"msg": null,
"data": [
{
"date": "2017-09-20",
"uv": 41,
"datatype": "mon",
"shopid": 0,
"id": 5,
"aid": 289714
}
]
}
*/
/**
* 狀態(tài)碼俯在，成功：0，失斖薰摺：其他
*/
private int count;
/**
* 總數(shù)（分頁）
*/
private int code;
/**
* 錯誤提示
*/
private String msg;
/**
* 數(shù)據(jù)集合
*/
private List<?> data;
/**
* @return the count
*/
public int getCount() {
return count;
}
/**
* @param count the count to set
*/
public void setCount(int count) {
this.count = count;
}
/**
* @return the code
*/
public int getCode() {
return code;
}
/**
* @param code the code to set
*/
public void setCode(int code) {
this.code = code;
}
/**
* @return the msg
*/
public String getMsg() {
return msg;
}
/**
* @param msg the msg to set
*/
public void setMsg(String msg) {
this.msg = msg;
}
/**
* @return the data
*/
public List<?> getData() {
return data;
}
/**
* @param data the data to set
*/
public void setData(List<?> data) {
this.data = data;
}
}
3.將框架內(nèi)的controller的返回格式設(shè)置為json格式跷乐，SpringMVC有兩種設(shè)置方式，分別為：
1.在controller上添加注解 @RestController趾浅，如圖：
@RestController
2.在controller上添加注解 @Controller愕提，然后在返回json字符串的方法前面添加注解 @ResponseBody，如圖：
@Controller
@ResponseBody
4.開始編寫代碼皿哨，這里只給出將查詢出來的數(shù)據(jù)封裝到定義好的返回?cái)?shù)據(jù)格式中浅侨，然后發(fā)送給客戶端，查詢語句請自行了解
//查詢數(shù)據(jù)方法
List<Map<String,Object>> contents=(List<Map<String, Object>>) iService.getContent(subId);
JsonBeanUtils json=new JsonBeanUtils();
if(contents.size()>0){
json.setCode(200);
json.setMsg("成功");
json.setCount(contents.size());
json.setData(contents);
}else{
json.setCode(400);
json.setMsg("失敗");
}
return json;
這樣就客戶端就會得到我們發(fā)送的數(shù)據(jù)证膨，發(fā)送的數(shù)據(jù)為：
{
"count": 6,
"code": 200,
"msg": "成功",
"data": [
{
"id": 1,
"name": "國學(xué)",
"status": 1
},
{
"id": 2,
"name": "數(shù)學(xué)",
"status": 1
},
{
"id": 3,
"name": "英語",
"status": 1
},
{
"id": 4,
"name": "生物",
"status": 1
},
{
"id": 5,
"name": "物理",
"status": 1
},
{
"id": 6,
"name": "化學(xué)",
"status": 1
}
]
}
這樣是不是看起來方便很多
5.服務(wù)端接受客戶端傳過來的參數(shù)如输，SpringMVC也有兩種方法，分別為：
1.直接在方法中接收央勒，如圖：方法中接收
2.在代碼中接受不见，如圖：
代碼中接受
6.我們只需將我們的項(xiàng)目部署到服務(wù)器上，那么客戶端的同事就可以訪問接口崔步，獲取數(shù)據(jù)稳吮，這樣服務(wù)端和客戶端的同事就可以愉快的玩耍了
