目录
一、如何定义一个接口?
1、确定协议
定义一个接口首先确定接口的协议,Http协议及具体的方法(GET、POST、PUT、DELETE)
2、请求
接下来需要分析请求及响应的数据格式与内容
get 请求时,前端请求key/value串,SpringMVC采用基本数据类型 (String、Integer等)或自定义类
型接收。
Post请求时,前端请Form表单数据 (application/x-www-form-urlencoded) 和Json数据(Content-Type=application/ison)、多部件类型数据 (multipart/form-data),对于Json数据SpringMVC使用@RequestBody注解解析请求的json数据
3、响应
基本上都是返回Json格式的响应结果
4、生成接口文档
使用swagger注解描述接口的内容,使用Swagger生成接口文档
二、如何进行接口开发?
1、首先要仔细阅读接口文档,搞清楚接口的协议、请求及响应的数据格式、http状态码要求等。
2、使用代码生成器生成Mapper接口、Mapper xml文件和PO类
3、编写Service接口与Service实现。
4、对自定义的Mapper与Service方法进行单元测试。
5、在Controller调用Service完成业务逻辑处理
6、使用HttpClient工具测试Controller接口
三、 接口异常如何处理?
接口在过程中存在异常由统一异常处理器进行处理
1、处理自定义异常
程序在编写代码时根据校验结果主动抛出自定义异常类XueChengPlusException的对象,并编写详细的异常信息,异常处理器捕获异常信息记录异常日志并响应给用户。
2、处理未知异常
接口执行过程中的一些运行时异常也会由异常处理器统一捕获,记录异常日志,统一响应给用户500错误及统一的异常信息。
异常处理器使用控制器增加注解@ControllerAdvice和异常处理注解@Exception