java接口的写法

最近在一个项目组里面写接口，因为本人是Andorid起家的（手动哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈），所以对接口特别熟悉（又爱又恨），现在将如何写接口的方法贴出来，让广大的客户端开发者不在去看后台同事的眼色了，毕竟咋也写了，哈哈哈，顺便说一句。。。。服务端、客户端都会写才是以后的发展趋势（手动哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈），话不多说，我们开始吧！！！

1.需要写接口，那么我们就需要一个适合自己的后台框架，现在主流的框架有Spring MVC、JFinal、以及一些好多个框架结合起来的新框架，这些都不重要，因为我们的度娘那儿都有呢，拿过来用就可以了，主要还是看代码，嘿嘿。这篇文章用的是springMVC。其余框架请自行百度学习

2.定义接口返回数据的格式，这个很重要的，因为这个东东如果设计好的话就会避免客户端的同事去埋怨你，所有最好和客户端的同事商量一下再做决定。

附上我们的数据格式

/**  
* @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
            }
          ]
        }
    */
    /**
     * 状态码，成功：0，失败：其他
     */
    private int count;
    /**
     * 总数（分页）
     */
    private int code;
    /**
     * 错误提示
     */
    private String msg;
    /**
     * 数据集合
     */
    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.将框架内的controller的返回格式设置为json格式，SpringMVC有两种设置方式，分别为：

1.在controller上添加注解 @RestController，如图：

@RestController

2.在controller上添加注解 @Controller，然后在返回json字符串的方法前面添加注解 @ResponseBody，如图：

@Controller
@ResponseBody

4.开始编写代码，这里只给出将查询出来的数据封装到定义好的返回数据格式中，然后发送给客户端，查询语句请自行了解

//查询数据方法
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;

这样就客户端就会得到我们发送的数据，发送的数据为：

{
    "count": 6,
    "code": 200,
    "msg": "成功",
    "data": [
        {
            "id": 1,
            "name": "国学",
            "status": 1
        },
        {
            "id": 2,
            "name": "数学",
            "status": 1
        },
        {
            "id": 3,
            "name": "英语",
            "status": 1
        },
        {
            "id": 4,
            "name": "生物",
            "status": 1
        },
        {
            "id": 5,
            "name": "物理",
            "status": 1
        },
        {
            "id": 6,
            "name": "化学",
            "status": 1
        }
    ]
}

这样是不是看起来方便很多

5.服务端接受客户端传过来的参数，SpringMVC也有两种方法，分别为：

1.直接在方法中接收，如图： 方法中接收

2.在代码中接受，如图：

代码中接受

6.我们只需将我们的项目部署到服务器上，那么客户端的同事就可以访问接口，获取数据，这样服务端和客户端的同事就可以愉快的玩耍了