目录

一、前言

二、Postman安装和使用

三、请求方式

四、资金记录接口实例演示

一、前言

    在前后端分离开发时，后端工作人员完成系统接口开发后，需要与前端人员对接，测试调试接口，验证接口的正确性可用性。而这要求前端开发进度和后端进度保持基本一致，任何一方的进度跟不上，都无法及时完成功能模块的测试。

    做为后端开发人员，要求独立开发完成某个接口后，开发人员自己需要先测试通过后再提交给测试人员进行测试，否则会出现到测试人员哪里业务流程根本就走不通，或者BUG会过多的情况等。

    市场上有很多优秀的，完善的接口测试工具，比如SoapUI，Postman等，能够高效的帮助后端开发人员独立进行接口测试。这里使用Postman接口测试工具，此处以请求方式为POST的userLogin登录接口为例。

二、Postman安装和使用

    1、这个直接去官网下载即可，我们使用免费版即可满足基本接口测试，根据个人或者公司的项目实际情况考虑是否需要专业版或者其他。

 

免费版官网链接：https://www.getpostman.com/postman

下载好的安装程序Postman-Win64-xxx-Setup.exe，双击安装即可。建议安装在非系统盘，即C盘在外的其他盘，另建议使用全英文路径，避免使用中文路径。

 


    2、打开Postman如下图2-1，可以关闭该页面跳过注册账户，非登陆状态下该工具可以直接使用。接下来出现引导页面，类似IDEA，Android Studio等开发工具的引导页。此处关闭即可。






 






3、进入Postman主页面并创建项目接口集合

    这里是我之前用过，所以左侧文件栏存在几个已有的文件夹。

    选择功能菜单New下的Collection创建项目接口集合。新建一个亿的项目A hundred million，可在Description部分写一下项目描述。






 






4、创建项目模块文件夹

    一般项目会分多个管理模块或者功能模块进行开发。这里可根据项目具体情况创建子文件夹方便接口管理。此处在A hundred million项目右键创建资产管理assets文件夹、user用户管理文件夹。可将测试的接口实例保存在对于管理模块下。







5、后台登录接口演示

    开发完成后台接口，编写正确严谨的逻辑代码处理前端请求。此处登录接口代码如下，运行后台开发项目，使该接口能够访问。接口请求路径为：http://localhost:8080/manage/app/user/login


@Controller
@RequestMapping("/manage/app/")
@Scope("prototype")
public class AppUserController {

   /**
    * 日志
    */
public static Logger customFile = LoggerFactory.getLogger("manageCustomFile");

@Resource
private AppUserService appUserService;

    /**
     * 用户登录
     * @param baseResult
     * @return
     */
    @RequestMapping(value = "user/login" , produces = "application/json;charset=UTF-8", method = RequestMethod.POST)
    @ResponseBody
    public BaseResult loginUser(@RequestBody BaseResult baseResult) {
        customFile.info("appId:"+ baseResult.getTreasureID()+ "用户登陆访问:" + baseResult.toString());
        return appUserService.loginUser(baseResult);
    }
}

6、新建接口测试

    在Postman主页面Content部分点击'+'按钮，新增一个接口测试。在图2-6所示第一部分填写接口请求路径，左侧下拉列表可选择请求方式，此处选择POST请求方式。接口请求路径为http://localhost:8080/manage/app/user/login。第二部分是请求体，即包含接口所需请求参数的Body，此处选择原始数据RAW，数据类型使用JSON数据作为请求数据。点击蓝色Send按钮发送请求，后台项目接口接收请求并响应返回执行结果。此处后台处理数据返回结果仍是JSON数据，这个看实际项目而定，此处仅做演示。第三部分是接口响应体，即接口响应请求处理并返回的数据。点击Pretty自动匹配接口返回的数据格式并对数据美化显示，使数据看起来更加直观。如果接口测试出现异常，则可以通过PreView视图查看浏览器响应接口的页面信息，也可以通过Header了解请求状态等参数。一般出现异常还是直接去后台看控制台的异常信息及项目日志来处理解决异常，再进行接口测试。







    接口测试通过后，可Ctrl+S保存接口测试实例，填写接口测试名称和接口描述信息，选择要保存的路径，此处保存在user用户管理模块文件夹。当项目的接口全部测试通过后，可在A hundred million项目右键Export导出接口文档，保存为JSON接口测试文件，该文件可通过Postman导入查看。



三、请求方式



    对于后台开发的接口，请求方式肯定不止POST一种，Postman也支持多种请求方式。在新建接口测试实例时可选择接口的请求方式，如图3-1。








    请求类型可以模拟Form表单文本提交，Form表单文件提交，raw原始数据提交，二进制文件提交。对于原始数据类型raw还支持不同文件格式，包括JSON，TXT，HTML等多种文件格式。








 



四、资金记录接口实例演示



    后台开发接口如下，服务器部署运行后台项目。接口请求路径为：http://localhost:8080/manage/app/user/asset/withdrawRecord


@Controller
@RequestMapping("/manage/app/")
@Scope("prototype")
public class AppUserAssetController {
 
    /**
     * 日志
     */
    public static Logger customFile = LoggerFactory.getLogger("manageCustomFile");

    @Resource
    private AppUserAssetService appUserAssetService;
    
    /**
     * 获取提现记录
     * 即我的页面中的资金记录
     * @param baseResult
     * @return
     */
    @RequestMapping(value = "user/asset/withdrawRecord" , produces = "application/json;charset=UTF-8", method = RequestMethod.POST)
    @ResponseBody
    public BaseResult getUserWithdrawRecord(@RequestBody BaseResult baseResult){
        customFile.info( "appId:"+ baseResult.getTreasureID() + "用户提现记录获取"+baseResult.toString());
        return appUserAssetService.getUserWithdrawRecord(baseResult);
    }
}

新建资金接口测试

请求方式为POST，

请求URL为http://localhost:8080/manage/app/user/asset/withdrawRecord

请求体为JSON类型的原始数据

点击Send请求接口，接口响应请求处理返回结果如图3-3所示







Powered By niaonao

 

1.接口

定义接口：interface关键字
子接口可以继承多个父接口
接口只能继承接口，不能继承类
接口的修饰符只能是public或者省略
接口的成员只能是public访问权限
在接口中定义成员变量时，必须用public static final 修饰符
接口里不能包含构造器和初始化块，但可以包含成员变量（只能是静态常量）、方法（只能是抽象实例方法、类方法、或默认方法）、内部类（包括内部接口、枚举）定义
接口里的普通方法不能有方法体，默认使用public abstract 修饰，但是类方法、默认方法都必须有方法体
接口中的默认方法默认使用public default 修饰，而默认方法需要使用接口的实现类的实例来调用，接口本身不能调用这些方法
类方法默认使用 public static 修饰，类方法可以直接使用接口来调用

2.接口

接口可以当成一个特殊的类，一个Java源文件中同样只能有一个public接口如果Java源文件中定义了一个public接口，则该源文件名必须与接口名相同
接口的继承：一个接口可以继承多个父接口（extends），多个父接口之间用 英文“,” 隔开
类继承接口时，使用implements关键词，同样实现的多个接口之间用英文“,”隔开
类继承接口时必须实现接口里的所有抽象方法，或者保留为自己的抽象方法，那么这个类也要定义为抽象类
接口与抽象类，接口是一种规范，而抽象类则是一个中间产品，它没有实现所有方法

为了方便各类开发者，现提供免费开放Api接口，所有接口均无使用限制，返回格式全是JSON，所以基本能满足大家的开发需求，但请各位不要将这些Api接入正式项目，因为有一些不稳定因素，目前服务器购买时长是三年，如果到期，我会自动续费，这些Api是我平时业余时间编写，可能有些不能满足需求的情况，请大家在留言区提出来，或者大家写Demo需要一些有关联的数据等等，都可以在留言区告诉我，我有时间一定会给大家处理。

api.apiopen.top

json.apiopen.top


目前接口列表：
新实时段子
https://api.apiopen.top/getJoke?page=1&count=2&type=video
通过Id查段子
https://api.apiopen.top/getSingleJoke?sid=28654780
快递查询：
https://api.apiopen.top/EmailSearch?number=1012002
随机单句诗词推荐：
https://api.apiopen.top/singlePoetry
随机一首诗词推荐：
https://api.apiopen.top/recommendPoetry
搜索古诗词：
https://api.apiopen.top/searchPoetry?name=古风二首%20二
搜索古诗词作者：
https://api.apiopen.top/searchAuthors?name=李白
模糊搜索古诗词（可搜索诗词名、诗词内容、诗词作者）：
https://api.apiopen.top/likePoetry?name=李白
获取宋朝古诗词：
https://api.apiopen.top/getSongPoetry?page=1&count=20
获取唐朝古诗词：
https://api.apiopen.top/getTangPoetry?page=1&count=20
音乐搜索接口：
https://api.apiopen.top/searchMusic?name=不要说话
音乐电台接口：
https://api.apiopen.top/musicBroadcasting
音乐电台详情接口：
https://api.apiopen.top/musicBroadcastingDetails?channelname=public_tuijian_spring
音乐详情接口：
https://api.apiopen.top/musicDetails?id=604392760
音乐排行榜接口：
https://api.apiopen.top/musicRankings
音乐排行榜详情接口：
https://api.apiopen.top/musicRankingsDetails?type=1
每日视频推荐接口：
https://api.apiopen.top/todayVideo
视频大纲获取接口：
https://api.apiopen.top/videoHomeTab
视频分类推荐接口：
https://api.apiopen.top/videoCategory
视频分类推荐接口：
https://api.apiopen.top/videoCategoryDetails?id=14
根据ID推荐接口：
https://api.apiopen.top/videoRecommend?id=127398
新闻接口：
https://www.apiopen.top/journalismApi
随机推荐热门段子（包含文字、图片、GIF、视频）：
https://www.apiopen.top/satinApi?type=1&page=1
随机推荐热门段子【神评版本】（包含文字、图片、GIF、视频）：
https://www.apiopen.top/satinGodApi?type=1&page=1
随机推荐热门段子【神评版本】评论列表：
https://www.apiopen.top/satinCommentApi?id=27610708&page=1
热门小说推荐列表
https://www.apiopen.top/novelApi
小说搜索接口
https://www.apiopen.top/novelSearchApi?name=盗墓笔记
小说详情接口
https://www.apiopen.top/novelInfoApi?name=盗墓笔记
天气获取接口
https://www.apiopen.top/weatherApi?city=成都
美图获取接口
https://www.apiopen.top/meituApi?page=1
个性网名获取接口
https://www.apiopen.top/femaleNameApi?page=1
创建应用接口
https://www.apiopen.top/createUserKey?appId=com.chat.peakchao&passwd=123456
增加统计信息接口
https://www.apiopen.top/addStatistics?appKey=00d91e8e0cca2b76f515926a36db68f5&type=点击统计&typeId=1&count=2
查询统计信息接口
https://www.apiopen.top/findStatistics?appKey=00d91e8e0cca2b76f515926a36db68f5
用户注册接口
https://www.apiopen.top/createUser?key=00d91e8e0cca2b76f515926a36db68f5&phone=13594347817&passwd=123654
用户登陆接口
https://www.apiopen.top/login?key=00d91e8e0cca2b76f515926a36db68f5&phone=13594347817&passwd=123456
由于数据来源于网络，如有侵权，请告知，我将立即删除。
还没写完，现在赶项目，有时间了继续完善。

                                   Java基础——接口

 

 

接口概念

    官方解释：Java接口是一系列方法的声明，是一些方法特征的集合，一个接口只有方法的特征没有方法的实现，因此这些方法可以在不同的地方被不同的类实现，而这些实现可以具有不同的行为（功能）。

    我的解释：接口可以理解为一种特殊的类，里面全部是由全局常量和公共的抽象方法所组成。接口是解决Java无法使用多继承的一种手段，但是接口在实际中更多的作用是制定标准的。或者我们可以直接把接口理解为100%的抽象类，既接口中的方法必须全部是抽象方法。（JDK1.8之前可以这样理解）

 

接口的特点

    就像一个类一样，一个接口也能够拥有方法和属性，但是在接口中声明的方法默认是抽象的。（即只有方法标识符，而没有方法体）。

 

接口指明了一个类必须要做什么和不能做什么，相当于类的蓝图。
	
一个接口就是描述一种能力，比如“运动员”也可以作为一个接口，并且任何实现“运动员”接口的类都必须有能力实现奔跑这个动作（或者implement move()方法），所以接口的作用就是告诉类，你要实现我这种接口代表的功能，你就必须实现某些方法，我才能承认你确实拥有该接口代表的某种能力。
	
如果一个类实现了一个接口中要求的所有的方法，然而没有提供方法体而仅仅只有方法标识，那么这个类一定是一个抽象类。（必须记住：抽象方法只能存在于抽象类或者接口中，但抽象类中却能存在非抽象方法，即有方法体的方法。接口是百分之百的抽象类）
	
一个JAVA库中接口的例子是：Comparator 接口，这个接口代表了“能够进行比较”这种能力，任何类只要实现了这个Comparator接口的话，这个类也具备了“比较”这种能力，那么就可以用来进行排序操作了。
为什么要用接口

    接口被用来描述一种抽象。
	
因为Java不像C++一样支持多继承，所以Java可以通过实现接口来弥补这个局限。
	
接口也被用来实现解耦。
	
接口被用来实现抽象，而抽象类也被用来实现抽象，为什么一定要用接口呢？接口和抽象类之间又有什么区别呢？原因是抽象类内部可能包含非final的变量，但是在接口中存在的变量一定是final，public,static的。
 

 

 

接口的语法实现

    为了声明一个接口，我们使用interface这个关键字，在接口中的所有方法都必须只声明方法标识，而不要去声明具体的方法体，因为具体的方法体的实现是由继承该接口的类来去实现的，因此，接口并不用管具体的实现。接口中的属性默认为Public Static Final.一个类实现这个接口必须实现这个接口中定义的所有的抽象方法。

    一个简单的接口就像这样：拥有全局变量和抽象方法。



    为了实现这个接口，我们使用implements关键词去实现接口：



其中testClass类实现了我们上面刚才定义的 in1 这个接口，既然你要实现接口，也就是实现接口代表的一种能力，那么你就必须去实现接口给你规定的方法，只有把接口给你规定的抽象方法都给实现了，才承认你这个类实现了这个接口，实现了这个接口代表的某种功能。上图实现了接口中规定的display（）方法。



    写一个测试类，用来测试一下我们刚才实现的这个接口，因为testclass类的对象t实现了接口规定的display方法，那么自然而然就可以调用display（）方法咯。



    有兴趣的同学可以去这个在线IDE亲自试一试：点击打开链接

 

 

接口的进一步理解

 

    我们知道，如果某个设备需要向电脑中读取或者写入某些东西，这些设备一般都是采用USB方式与电脑连接的，我们发现，只要带有USB功能的设备就可以插入电脑中使用了，那么我们可以认为USB就是一种功能，这种功能能够做出很多的事情（实现很多的方法），其实USB就可以看做是一种标准，一种接口，只要实现了USB标准的设备我就认为你已经拥有了USB这种功能。（因为你实现了我USB标准中规定的方法），下面是具体的例子：

 

先声明USB接口：其中规定了要实现USB接口就必须实现接口规定实现的read( )和write( )这两个方法。


interface USB {

    void read();


    void write();

}


然后在写一个U盘类和一个键盘类，这两个类都去实现USB接口。（实现其中的方法）


class YouPan implements USB {

    @Override

    public void read() {

        System.out.println("U盘正在通过USB功能读取数据");

    }

    @Override

    public void write() {

        System.out.println("U盘正在通过USB功能写入数据");

    }

}


 

 

这是U盘的具体实现。


class JianPan implements USB {

    @Override

    public void read() {

        System.out.println("键盘正在通过USB功能读取数据");

    }

    @Override

    public void write() {

        System.out.println("键盘正在通过USB功能写入数据");

    }

}


 

 

这是键盘的具体实现。

    那么，现在U盘和键盘都实现了USB功能，也就是说U盘和键盘都能够调用USB接口中规定的方法，并且他们实现的方式都不一样。

我们在写一个测试，来看看具体的实现：


public class Main {

    public static void main(String[] args) {

        //生成一个实现可USB接口（标准）的U盘对象

        YouPan youPan = new YouPan();

        //调用U盘的read( )方法读取数据

        youPan.read();

        //调用U盘的write( )方法写入数据

        youPan.write();

        //生成一个实现可USB接口（标准）的键盘对象

        JianPan jianPan = new JianPan();

        //调用键盘的read( )方法读取数据

        jianPan.read();

        //调用键盘的write( )方法写入数据

        jianPan.write();

    }

}

 


 

 

结果如下：

 



 

    感兴趣的同学可以去在线IDE平台自己验证一下：点击打开链接

 

 

关于接口的几个重点

我们不能直接去实例化一个接口，因为接口中的方法都是抽象的，是没有方法体的，这样怎么可能产生具体的实例呢？但是，我们可以使用接口类型的引用指向一个实现了该接口的对象，并且可以调用这个接口中的方法。因此，上图中最后的方法调用我们还可以这样写：（实际上就是使用了Java中多态的特性）

public class Main {

    public static void main(String[] args) {

        //生成一个实现可USB接口（标准）的U盘对象

        //但是使用一个接口引用指向对象

        //USB接口类引用可以指向一个实现了USB接口的对象

        USB youPan = new YouPan();

        //调用U盘的read( )方法读取数据

        youPan.read();

        //调用U盘的write( )方法写入数据

        youPan.write();

        //生成一个实现可USB接口（标准）的键盘对象

        //但是使用一个接口引用指向对象

        //USB接口类引用可以指向一个实现了USB接口的对象

        USB jianPan = new JianPan();

        //调用键盘的read( )方法读取数据

        jianPan.read();

        //调用键盘的write( )方法写入数据

        jianPan.write();

    }

}                                                                                                                                     


 

 2.一个类可以实现不止一个接口。

 

3.一个接口可以继承于另一个接口，或者另一些接口，接口也可以继承，并且可以多继承。

4.一个类如果要实现某个接口的话，那么它必须要实现这个接口中的所有方法。

5.接口中所有的方法都是抽象的和public的，所有的属性都是public,static,final的。

6.接口用来弥补类无法实现多继承的局限。

7.接口也可以用来实现解耦。

接口的通俗理解

 

    前面我们讲多态的时候用“空调”——“遥控器”的方式去理解多态，实际上在上面的的几个重点中的第一条讲的也是多态的实现，比如，我们可以把“节能”作为一种标准，或者说节能就是一个“接口”，这个接口中有一个方法，叫做变频方法，任何空调，如果要称得上叫做节能空调的话，那么必须实现“节能”这个接口，实现“节能”这个接口，也就必须实现“节能”接口中规定实现的“变频”方法，这样才算是真正的实现了“节能”这个接口，实现了“节能”这个功能。

    当某个空调实现了“节能”接口后，这个空调就具备了节能的功能，那么我们也可以不用空调类的引用指向空调对象，我们可以直接使用一个“节能”接口类型引用的“遥控器”去指向“空调”，虽然这个“遥控器”上面只有一个按键，只有一个“变频”的方法，但是“遥控器”所指向的空调是实现了“节能”这个接口的，是有“变频”方法的实现的，我们用这个只有一个“变频”方法的遥控器去命令空调调用“变频”方法，也是行得通的，实在不清楚的同学可以去看我的另一篇文章：JAVA之对象的多态性。

 

 

接口的标识用法

    虽然接口内部定义了一些抽象方法，但是并不是所有的接口内部都必须要有方法，比如Seriallizable接口，Seriallizable接口的作用是使对象能够“序列化”，但是Seriallizable接口中却没有任何内容，也就是说，如果有一个类需要实现“序列化”的功能，则这个类必须去实现Seriallizable接口，但是却并不用实现方法（因为接口中没有方法），此时，这个Serilizable接口就仅仅是一个“标识”接口，是用来标志一个类的，标志这个类具有这个“序列化”功能。具体的实现请参考我的另一篇文章——JAVA之IO流。

 

接口在生活中的思想体现

其实，在我们的生活当中，有很多地方都体现了“接口”的思想，想必，正在阅读这篇博文的你，是不是也喜欢摄影呢？



玩摄影的童鞋都知道，单反由相机和镜头组成，相机分不同的型号，有半画幅的，也有全画幅的。镜头也是一样的，分长焦，短焦；还有定焦和变焦。每种镜头都有各自特定的发挥场景。正是因为镜头的多元化，使得我们的摄影能够“术业有专攻”。大家想一想，如果我们的单反相机部分和镜头部分是固定在一起的，不能够更换镜头，那么将会多么的糟糕啊！

因此，每个相机品牌为了能够兼容不同的镜头，各自发布了一套镜头卡口的标准，这套标准就好比我们前面提到的“接口”，都是某种“约束”。举个栗子，我们佳能的相机，不管你是哪一家镜头生产厂商，腾龙也好，适马也好，只要你按照我佳能卡口的标准来生产镜头，你生产的镜头都能够很好的在我佳能相机上面驱动。



因此，当我们打开“狗东”，准备给自己的新相机买镜头的时候，就不难发现，我们需要根据自己相机的品牌来挑选特定卡口的镜头，这样的镜头才能被我们的相机正常驱动。



回到Java上面来说，其实接口给我们带来的最大的好处就是“解耦”了，相机能够搭配不同的镜头，才能有各种各样的搭配玩法，变得更加的灵活。在软件系统中也是一样的，接口可以有很多不同“特色”的实现类，我们只需要声明同一个接口，却可以引用很多个该“接口”引申出来的“子类”，这不也大大增强了我们软件系统中组件的灵活性吗？

聪明的你，对于“接口”的理解是不是又更加的深入了呢？

 

参考资料

1.《Java开发实战经典》 李兴华著  清华大学出版社

2.https://www.geeksforgeeks.org/interfaces-in-java  作者：Mehak Kumar. and Nitsdheerendra.   翻译：刘扬俊

 

博客文章版权说明

第一条 本博客文章仅代表作者本人的观点，不保证文章等内容的有效性。

第二条 本博客部分内容转载于合作站点或摘录于部分书籍，但都会注明作/译者和原出处。如有不妥之处，敬请指出。

第三条 在征得本博客作者同意的情况下，本博客的作品允许非盈利性引用，并请注明出处：“作者：____转载自____”字样，以尊重作者的劳动成果。版权归原作/译者所有。未经允许，严禁转载。

第四条 对非法转载者，“扬俊的小屋”和作/译者保留采用法律手段追究的权利。

第五条 本博客之声明以及其修改权、更新权及最终解释权均属“扬俊的小屋”。

第六条 以上声明的解释权归“扬俊的小屋”所有。