六、 Spring Boot 之 REST

REST 即表现层状态转换（REST，英文：Representational State Transfer）. 适合终端到 Server 的调用。

1 .REST 概述

资源 (Resources )
资源就是网络上的一个具体的信息。可以使用 URI 来映射该资源，因此 URI 是描述唯一资源的标识符。
表现层 (Representational )
资源是一种信息的载体，资源可以有多种表现形式。可以使用请求头来表示，通常使用的是后缀来区分。
状态转化( State Transfer )
访问资源的过程中，涉及数据状态的变化，通过 HTTP 协议中的请求方法 (GET/POST/PUT/DELETE/PATCH) 来定义操作数据状态的转化

HTTP 请求方式	含义
POST	增加资源
PUT	更改资源，客户端提供需要提供完整的资源属性
GET	查询资源
PATCH	更新资源，客户端提供仅需要的资源属性
DELETE	删除资源
HEAD	类似 GET ,但仅仅只有 HTTP 头信息,头信息包含了需要查找的信息，一般为该资源的元信息，如资源是否存在，长度等
OPTIONS	用于获取 URI 所支持的方法，响应信息会在 HTTP 头中包含一个名为 "Allow" 的头。值是支持的方法，如 GET / POST

2. Spring Boot 集成 REST 应用开发

pom 文件配置

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.zj.sp.rest</groupId>
    <artifactId>sp-zj-rest-demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>sp-zj-rest-demo</name>
    <description></description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.5.RELEASE</version>
        <relativePath /> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.1.11</version>
        </dependency>


        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>


</project>

REST 接口开发

package org.zj.sp.rest.spzjrestdemo.user.controller;

import java.util.List;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.zj.sp.rest.spzjrestdemo.user.model.UserModel;
import org.zj.sp.rest.spzjrestdemo.user.repository.UserRepository;

@RestController
@RequestMapping(path="/api/v1/user/")
public class UserApiController {
    
    private static  final Logger logger = LoggerFactory.getLogger(UserApiController.class);
    
    @Autowired
    UserRepository userRepository;
    
    /**
     *      查询用户列表, 返回 JSON 数据
     */
    @GetMapping
    public List<UserModel> getUsers(){
        
        
        return userRepository.findAll();
    } 
    /**
     *      按 id 查询用户, 返回 JSON 数据
     */
    @GetMapping("{id}")
    public UserModel getUser(@PathVariable("id") Long id) {
        
        logger.info("=================" + id);
        
        return userRepository.getOne(id);
    }
    
    /**
     *      新增用户
     */
    @PostMapping(consumes=MediaType.APPLICATION_JSON_UTF8_VALUE)
    public void addUser(@RequestBody UserModel model) {
        
        logger.info(model.toString());
        
        userRepository.save(model);
        
    }
    /**
     *      修改用户
     */
    @PutMapping
    public void modifyUser(@RequestBody UserModel model) {
        userRepository.save(model);
    }
    
    @DeleteMapping("{id}")
    public void deleteUser(@PathVariable("id") Long id) {
        userRepository.deleteById(id);
    }
}

配置文件

spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
spring.datasource.url=jdbc:mysql://192.168.1.6:3306/testdb?useUnicode=true&characterEncoding=utf8&useSSL=true
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

spring.jpa.properties.hibernate.hbm2ddl.auto=update
spring.jpa.show-sql=true

logging.level.root=error
logging.level.org.zj=debug

测试结果

接口测试结果图

3. Swagger UI

Swagger UI 是 REST 接口的一个工具，可以使用Swagger UI 来描述和规范接口

pom 配置 Swagger UI

    <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

javaConfig 配置 Swagger

        @Bean
        public Docket alipayApi() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .groupName("用户API接口文档")  
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("org.zj.sp.rest.spzjrestdemo.user.controller"))
                    .paths(PathSelectors.any()).build();
        }
        
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    .title("用户服务")
                    .description("用户服务接口")
                    .termsOfServiceUrl("https://www.jianshu.com/u/d775c518e5ba")
                    .contact(new Contact("联系方式 ", "https://www.jianshu.com/u/d775c518e5ba", "93414020@qq.com"))
                    .version("1.0").build();
        }

接口 Swagger 注解配置

package org.zj.sp.rest.spzjrestdemo.user.controller;

import java.util.List;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.zj.sp.rest.spzjrestdemo.user.model.UserModel;
import org.zj.sp.rest.spzjrestdemo.user.repository.UserRepository;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;

@RestController
@RequestMapping(path="/api/v1/user/")
@Api(tags="用户接口")
public class UserApiController {
    
    private static  final Logger logger = LoggerFactory.getLogger(UserApiController.class);
    
    @Autowired
    UserRepository userRepository;
    
    /**
     *      查询用户列表, 返回 JSON 数据
     */
    @GetMapping
    @ApiOperation(value="查询用户列表")
    public List<UserModel> getUsers(){
        
        
        return userRepository.findAll();
    } 
    /**
     *      按 id 查询用户, 返回 JSON 数据
     */
    @GetMapping("{id}")
    @ApiOperation(value="通过id 查询用户")
    @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long")
    public UserModel getUser(@PathVariable("id") Long id) {
        
        logger.info("=================" + id);
        
        return userRepository.getOne(id);
    }
    
    /**
     *      新增用户
     */
    @PostMapping(consumes=MediaType.APPLICATION_JSON_UTF8_VALUE)
    @ApiOperation(value="新增用户")
    @ApiImplicitParam(name = "model", value = "用户详细实体UserModel", required = true, dataType = "UserModel")
    public void addUser(@RequestBody UserModel model) {
        
        logger.info(model.toString());
        
        userRepository.save(model);
        
    }
    /**
     *      修改用户
     */
    @PutMapping
    @ApiOperation(value="更新用户")
    @ApiImplicitParam(name = "model", value = "用户详细实体UserModel", required = true, dataType = "UserModel")
    public void modifyUser(@RequestBody UserModel model) {
        userRepository.save(model);
    }
    
    @DeleteMapping("{id}")
    @ApiOperation(value="通过id 删除用户")
    @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long")
    public void deleteUser(@PathVariable("id") Long id) {
        userRepository.deleteById(id);
    }
}

swagger 常用注解

@Api：用在类上，说明该类的作用
@ApiOperation：用在方法上，说明方法的作用
@ApiImplicitParams：用在方法上包含一组参数说明
@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
    paramType：参数放在哪个地方
        header–>请求参数的获取：@RequestHeader
        query–>请求参数的获取：@RequestParam
        path（用于restful接口）–>请求参数的获取：@PathVariable
        body（不常用）
        form（不常用）
    name：参数名
    dataType：参数类型
    required：参数是否必须传
    value：参数的意思
    defaultValue：参数的默认值
@ApiResponses：用于表示一组响应
@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
    code：数字，例如400
    message：信息，例如”请求参数没填好”
    response：抛出异常的类
@ApiModel：描述一个Model的信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）
    @ApiModelProperty：描述一个model的属性

swagger 测试图

测试

源码下载：

https://github.com/cqzhangjian/SpringBoot-REST.git

最后编辑于：2018.09.24 21:23:04

人面猴
序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
沈念sama阅读 159,015评论 4赞 362
死咒
序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
沈念sama阅读 67,262评论 1赞 292
救了他两次的神仙让他今天三更去死
文/潘晓璐我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
开封第一讲书人阅读 108,727评论 0赞 243
道士缉凶录：失踪的卖姜人
文/不坏的土叔我叫张陵，是天一观的道长。经常有香客问我，道长，这世上最难降的妖魔是什么？我笑而不...
开封第一讲书人阅读 43,986评论 0赞 205
港岛之恋（遗憾婚礼）
正文为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
茶点故事阅读 52,363评论 3赞 287
恶毒庶女顶嫁案：这布局不是一般人想出来的
文/花漫我一把揭开白布。她就那样静静地躺着，像睡着了一般。火红的嫁衣衬着肌肤如雪。梳的纹丝不乱的头发上，一...
开封第一讲书人阅读 40,610评论 1赞 219
城市分裂传说
那天，我揣着相机与录音，去河边找鬼。笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。我是一名探鬼主播，决...
沈念sama阅读 31,871评论 2赞 312
双鸳鸯连环套：你想象不到人心有多黑
文/苍兰香墨我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
开封第一讲书人阅读 30,582评论 0赞 198
万荣杀人案实录
序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
沈念sama阅读 34,297评论 1赞 242
护林员之死
正文独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋以下内容为张勋视角年9月15日...
茶点故事阅读 30,551评论 2赞 246
白月光启示录
正文我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
茶点故事阅读 32,053评论 1赞 260
活死人
序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
沈念sama阅读 28,385评论 2赞 253
日本核电站爆炸内幕
正文年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
茶点故事阅读 33,035评论 3赞 236
男人毒药：我在死后第九天来索命
文/蒙蒙一、第九天我趴在偏房一处隐蔽的房顶上张望。院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
开封第一讲书人阅读 26,079评论 0赞 8
一桩弑父案，背后竟有这般阴谋
文/苍兰香墨我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。一阵脚步声响...
开封第一讲书人阅读 26,841评论 0赞 195
情欲美人皮
我被黑心中介骗来泰国打工，没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。一个月前我还...
沈念sama阅读 35,648评论 2赞 274
代替公主和亲
正文我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
茶点故事阅读 35,550评论 2赞 270

六、 Spring Boot 之 REST

1 .REST 概述

2. Spring Boot 集成 REST 应用开发

3. Swagger UI

源码下载 ：

推荐阅读更多精彩内容

源码下载：