基于Spring Boot的RESTful API实践
Posted
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了基于Spring Boot的RESTful API实践相关的知识，希望对你有一定的参考价值。
1. RESTful简述
REST是一种设计风格，是一组约束条件及原则，而遵循REST风格的架构就称为RESTful架构，资源是RESTful的核心，一个好的RESTful架构，通过URL就能很清晰的了解其相应的操作和需求是什么，即
1. 通过URL定位资源,如：
com.mobin/api/v1/shenzhen/subways //获取深圳地铁列表
com.mobin/api/v1/shenzhen/schools //获取深圳学校列表
2. HTTP描述操作
GET：获取资源
POST：创建资源
PUT：更新资源
DELETE：删除资源
如：
GET com.mobin/api/v1/shenzhen/subways/1：获取ID为1的地铁信息
请求的资源通常都以JSON或XML等返回给Client，使用RESTful架构只需在Sever端提供一套RESTful API便能在web、ios、android共用
API设计是个很讲究的事情，可以参考GitHub的API设计规范
2. SpringBoot集成MyBatis
1. 将xxxMapper.xml及sqlMapConfig.xml放入resource对应目录
2. application.properties加载MyBatis配置文件及配置数据源
1 ##application.properties 2 #加载mybatis配置文件 3 mybatis.mapper-locations = classpath:mapper/*Mapper.xml 4 mybatis.config-location = classpath:mapper/config/sqlMapConfig.xml 5 ? 6 #指定别名 7 mybatis.type-aliases-package = com.mobin.entity 8 ? 9 #数据源 10 spring.datasource.url = jdbc:postgresql://localhost:5432/xxx 11 spring.datasource.driver-class-name = org.postgresql.Driver 12 spring.datasource.username = postgres 13 spring.datasource.password = xxxx
MyBatis 3之后官方提供了特定的API来的支持动态SQL，可以使用注解+Java代码来替代XML，但是复杂的SQL语句还是走XML的方式，XML更直观(其实也恶心)，注解的方式对于代码的侵入太严重，修改后还需要重新编译。
3. 日志配置
Spring boot默认的日志框架为Logback，配置起来相当友好具有更好的性能,还可以对指定的服务的日志进行不同级别的过滤并不影响其他服务日志的级别
1. 控制台日志配置
2. 开发、测试、生产环境的配置
1 ##logbcak-spring.xml 2 <?xml version="1.0" encoding="UTF-8"?> 3 <configuration debug="false"> 4 <contextName>${appname}</contextName> 5 <!--控制台日志配置--> 6 <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> 7 <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> 8 <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread]%-5level %logger{50} - %msg%n</pattern> 9 </encoder> 10 </appender> 11 ? 12 <appender name="FILEPROD" class="ch.qos.logback.core.rolling.RollingFileAppender"> 13 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> 14 <FileNamePattern>SpringBootRESTful.%d{yyyy-MM-dd}.log</FileNamePattern> 15 <!-- 日志保留天数--> 16 <MaxHistory>20</MaxHistory> 17 </rollingPolicy> 18 <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> 19 <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread]%-5level %logger{50} - %msg%n</pattern> 20 </encoder> 21 </appender> 22 ? 23 <appender name="FILETEST" class="ch.qos.logback.core.rolling.RollingFileAppender"> 24 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> 25 <FileNamePattern>test.SpringBootRESTful.%d{yyyy-MM-dd}.log</FileNamePattern> 26 <MaxHistory>20</MaxHistory> 27 </rollingPolicy> 28 <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> 29 <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread]%-5level %logger{50} - %msg%n</pattern> 30 </encoder> 31 </appender> 32 ? 33 <!--开发环境的日志配置 --> 34 <springProfile name="dev"> 35 <!--开发环境通常会对指定包或类进行测试 --> 36 <logger name="com.mobin.dao" level="DEBUG"> 37 <appender-ref ref="STDOUT"/> 38 </logger> 39 <root level="INFO"> 40 <appender-ref ref="STDOUT"/> 41 </root> 42 </springProfile> 43 ? 44 <!--测试环境的日志配置 --> 45 <springProfile name="test"> 46 <root level="DEBUG"> 47 <appender-ref ref="FILETEST"/> 48 <appender-ref ref="STDOUT"/> 49 </root> 50 </springProfile> 51 ? 52 <!--生产环境的日志配置 --> 53 <springProfile name="prod"> 54 <root level="INFO"> 55 <appender-ref ref="FILEINFO"/> 56 <appender-ref ref="STDOUT"/> 57 </root> 58 </springProfile> 59 </configuration>
4. 异常处理
4.1 在API设计规范中，对异常的处理至少是
1. 返回相应的错误代码
2. 返回相应的错误描述
3. 对应的资源模块
4.2 使用@RestControllerAdvice定义全局异常处理
@RestControllerAdvice是Spring 4.3之后的新特性，其相当于@ControllerAdvice+ResponseBody，所以使用@RestControllerAdvice可以将错误信息以Json的格式返回
1. 自定义异常类
1 ##com.mobin.exception.EntityNotFoundException 2 //当请求的资源不存在时抛出该异常 3 public class EntityNotFoundException extends RuntimeException{ 4 public EntityNotFoundException(String mes){ 5 super(mes); 6 } 7 }
2. 定义全局异常类
1 ##com.mobin.exception.GlobalExceptionHadlerActice 2 @RestControllerAdvice 3 public class GlobalExceptionHadlerActice { 4 private static final long serialVersionUID = 1L; 5 @ExceptionHandler(value = EntityNotFoundException.class) 6 public ErrorMessage entityNotFoundException(HttpServletRequest request, Exception e){ 7 ErrorMessage errorMessage = new ErrorMessage(); 8 errorMessage.setStatus(HttpStatus.NOT_FOUND.value()); 9 errorMessage.setMessage(e.getLocalizedMessage()); 10 errorMessage.setUrl(request.getRequestURL().toString()); 11 return errorMessage; 12 } 13 }
ErrorMessage为自定义的实体类，包含statusCode,message及url字段。
3. 相应的请求方法
1 ## com.mobin.controller.SubwayController 2 @RequestMapping(value="/{id}",method = RequestMethod.GET ) 3 public SubwayResult<Subway> getSubwayByID(@PathVariable Integer id) { 4 SubwayResult<Subway> result = new SubwayResult(); 5 Subway subway = subwayService.findSubwayByID(id); 6 if (subway == null){ 7 throw new EntityNotFoundException("资源不存在"); 8 } 9 result.setStatus(HttpStatus.OK.value()); 10 result.setData(subway); 11 return result; 12 }
4. 通过curl进行测试
1 MOBIN:~ mobin$ curl -XGET -w "\n" ‘localhost:8089/api/subways/1999‘ 2 { 3 "message":"资源不存在", 4 "status":404, 5 "url":"http://localhost:8089/api/subways/1999" 6 }
5. 使用fastjson
1. 引入fastJson依赖
2. 自定义WebMvcConfigurer并继承WebMvcConfigurerAdapter
3. 重写configureMessageConverters方法
4. 自定义配置FastJsonConfig
5. 将FastJsonHttpMessageConverter添加到HttpMessageConverter
相应代码：
1 ##com.mobin.config.WebMvcConfigurer 2 @Configuration 3 public class WebMvcConfigurer extends WebMvcConfigurerAdapter{ 4 @Override 5 public void configureMessageConverters(List<HttpMessageConverter<?>> converters) { 6 FastJsonHttpMessageConverter converter = new FastJsonHttpMessageConverter(); 7 FastJsonConfig config = new FastJsonConfig(); 8 config.setSerializerFeatures(SerializerFeature.WriteNullListAsEmpty, 9 SerializerFeature.WriteMapNullValue, 10 SerializerFeature.WriteNullStringAsEmpty, 11 SerializerFeature.WriteNullBooleanAsFalse, 12 SerializerFeature.PrettyFormat); 13 converter.setDateFormat("yyyy-MM-dd HH:mm:ss"); 14 converter.setFastJsonConfig(config); 15 converters.add(converter); 1617 } 18 }
SerializerFeature.WriteNullListAsEmpty：List类型字段为null时输出[]而非null
SerializerFeature.WriteMapNullValue：显示空字段
SerializerFeature.WriteNullStringAsEmpty：字符串类型字段为null时间输出""而非null
SerializerFeature.WriteNullBooleanAsFalse：Boolean类型字段为null时输出false而null
SerializerFeature.PrettyFormat：美化json输出，否则会作为整行输出
解决浏览器中返回json显示乱码问题（参考自：http://blog.csdn.net/kingboyworld/article/details/70068676）
##application.properties spring.http.encoding.charset=UTF-8 spring.http.encoding.enable=true spring.http.encoding.force=true
6. 使用PageHelper进行分页
分页使用的是PageHelper插件，基本原理就是在Executor及mappedStatement之间对SQL语句进行拦截并对SQL添加相应的分页操作再封装传递给mappedStatement,该插件支持单表及多表的分页，使用方便，只需在SQL执行语句前加上一条分布代码即可（通常是在server层），想想如果是手动的设置SQL语句的limit和offset，分页场景一旦多了就特别恶心，即便配合MyBatis的逆向工程也是。
1. 引入Spring boot对应的PageHelper依赖
2. 在application.properties配置PageHelper
3. 在指定的SQL语句前添加分页代码
1 ##application.properties 2 #指定数据库方言 3 pagehelper.helperDialect=postgresql 4 #pageNum<=0时返回第一页数据，pageNum超过总页数时返回最后一页数据 5 pagehelper.reasonable=true
相应代码：
1 ##com.mobin.service.impl.SubwayServiceImpl 2 public List<Subway> findSubways(int pageNum,int pageSize){ 3 //第三个参数为fales时表示不对表进行count操作 4 PageHelper.startPage(pageNum,pageSize,false); 5 return subwayMapper.findSubways(); 6 }
项目地址：
https://github.com/MOBIN-F/SpringBootRESTful
参考资料:
How to use @RestControllerAdvice for handling Exception with RestfulApi
以上是关于基于Spring Boot的RESTful API实践的主要内容，如果未能解决你的问题，请参考以下文章
??????spring boot??????restful api