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.我们只需将我们的项目部署到服务器上,那么客户端的同事就可以访问接口,获取数据,这样服务端和客户端的同事就可以愉快的玩耍了

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 201,681评论 5 474
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,710评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,623评论 0 334
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,202评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,232评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,368评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,795评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,461评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,647评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,476评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,525评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,226评论 3 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,785评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,857评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,090评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,647评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,215评论 2 341

推荐阅读更多精彩内容