SpringBoot2.x【六】整合 Rest API 接口規範

Spring Boot 通過提供開箱即用的預設依賴或者轉換來補充Spring REST支援。在Spring Boot中編寫RESTful服務與SpringMVC沒有什麼不同。總而言之，基于Spring Boot的REST服務與基于Spring的REST服務完全相同，隻是在我們引導底層應用程式的方式上有所不同。

1.REST簡短介紹

REST代表Representational State Transfer. 是一種架構風格，設計風格而不是标準，可用于設計Web服務，可以從各種用戶端使用.

基于REST的基本設計，其是根據一組動詞來控制的操作

建立操作：應使用HTTP POST
查詢操作：應使用HTTP GET
更新操作：應使用HTTP PUT
删除操作：應使用HTTP DELETE

作為REST服務開發人員或用戶端，您應該遵守上述标準。

2.準備工作

項目的環境工具

SpringBoot 2.0.1.RELEASE
Gradle 4.7
IDEA 2018.2
MySQL5.7

項目結構圖

SpringBoot2.x【六】整合 Rest API 接口規範SpringBoot2.x【六】整合 Rest API 接口規範

3.開始

下面基于一種方式講解Restful

package com.example.controller;

import com.example.beans.PageResultBean;
import com.example.beans.ResultBean;
import com.example.entity.User;
import com.example.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
@RequestMapping("/user")
public class UserControllerAPI {

    private final UserService userService;

    @Autowired
    public UserControllerAPI(UserService userService) {
        this.userService = userService;
    }

    @RequestMapping(value = "/api", method = RequestMethod.GET)
    public PageResultBean<List<User>> getUserAll(PageResultBean page) {
        return new PageResultBean<>(userService.getUserAll(page.getPageNo(), page.getPageSize()));
    }

    @RequestMapping(value = "/api/{id}", method = RequestMethod.GET)
    public ResultBean<User> getUserByPrimaryKey(@PathVariable("id") Integer id) {
        return new ResultBean<>(userService.selectByPrimaryKey(id));
    }

    @RequestMapping(value = "/api/{id}", method = RequestMethod.PUT)
    public ResultBean<Integer> updateUserByPrimaryKey(@PathVariable("id") Integer id,User user) {
        user.setId(id);
        return new ResultBean<>(userService.updateByPrimaryKeySelective(user));
    }

    @RequestMapping(value = "/api/{id}", method = RequestMethod.DELETE)
    public ResultBean<String> deletePrimaryKey(@PathVariable("id") Integer id) {
        return new ResultBean<>(userService.deleteByPrimaryKey(id));
    }

    @RequestMapping(value = "/api", method = RequestMethod.POST)
    public ResultBean<Integer> createPrimaryKey(User user) {
        return new ResultBean<>(userService.insertSelective(user));
    }

}

對于/user/api HTTP GET來請求擷取全部使用者
對于/user/api HTTP POST來建立使用者
對于/user/api/1 HTTP GET請求來擷取id為1的使用者
對于/user/api/1 HTTP PUT請求來更新
對于/user/api/1 HTTP DELETE請求來删除id為1的使用者

HTTP GET請求/user/api 查詢全部

URL：http://localhost:8080/user/api

HTTP GET請求/user/api/65 跟據id查詢

URL:http://localhost:8080/user/api/65

HTTP POST請求/user/api 建立使用者

URL:http://localhost:8080/user/api

HTTP PUT請求/user/api/65 來更新使用者資訊

URL:http://localhost:8080/user/api/65

HTTP DELETE請求/user/api/85 來删除id為85的使用者

URL:http://localhost:8080/user/api/85

4.業務層及dao層代碼

UserService.java 接口

package com.example.service;

import com.example.entity.User;

import java.util.List;

public interface UserService {

    /**
     * 删除
     * @param id
     * @return
     */
    String deleteByPrimaryKey(Integer id);

    /**
     * 建立
     * @param record
     * @return
     */
    int insertSelective(User record);

    /**
     * 單個查詢
     * @param id
     * @return
     */
    User selectByPrimaryKey(Integer id);

    /**
     * 更新
     * @param record
     * @return
     */
    int updateByPrimaryKeySelective(User record);

    /**
     * 查詢全部
     * @return
     */
    List<User> getUserAll(Integer pageNum, Integer pageSize);
}

UserServiceImpl.java

package com.example.service.impl;

import com.example.dao.UserMapper;
import com.example.entity.User;
import com.example.service.UserService;
import com.github.pagehelper.PageHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import java.util.List;

@Service
public class UserServiceImpl implements UserService {

    private final static Logger logger = LoggerFactory.getLogger(UserServiceImpl.class);

    private final UserMapper userMapper;

    @Autowired(required = false)
    public UserServiceImpl(UserMapper userMapper) {
        this.userMapper = userMapper;
    }

    /**
     * 删除
     *
     * @param id
     * @return
     */
    @Transactional
    @Override
    public String deleteByPrimaryKey(Integer id) {
        logger.info("UserServiceImpl deleteByPrimaryKey id => " + id);
        User user = userMapper.selectByPrimaryKey(id);
        String result;
        if (user == null) {
            result = "使用者ID[" + id + "]找不到!";
        } else {
            result = String.valueOf(userMapper.deleteByPrimaryKey(id));
        }
        return result;
    }

    /**
     * 建立
     *
     * @param record
     * @return
     */
    @Transactional
    @Override
    public int insertSelective(User record) {
        logger.info("UserServiceImpl insertSelective record=>"+record.toString());
        return userMapper.insertSelective(record);
    }

    /**
     * 單個查詢
     *
     * @param id
     * @return
     */
    @Override
    public User selectByPrimaryKey(Integer id) {
        logger.info("UserServiceImpl selectByPrimaryKey id=>"+id);
        return userMapper.selectByPrimaryKey(id);
    }

    /**
     * 更新
     *
     * @param record
     * @return
     */
    @Override
    public int updateByPrimaryKeySelective(User record) {
        logger.info("UserServiceImpl updateByPrimaryKeySelective record=>"+record.toString());
        return userMapper.updateByPrimaryKeySelective(record);
    }

    /**
     * 查詢全部
     *
     * @param pageNum
     * @param pageSize
     * @return
     */
    @Override
    public List<User> getUserAll(Integer pageNum, Integer pageSize) {
        logger.info("UserServiceImpl getUserAll pageNum=>"+pageNum+"=>pageSize=>"+pageSize);
        PageHelper.startPage(pageNum,pageSize);
        List<User> userList = userMapper.getUserAll();
        logger.info("UserServiceImpl getUserAll userList"+userList.size());
        return userList;
    }
}

UserMapper.java

package com.example.dao;

import com.example.entity.User;

import java.util.List;

public interface UserMapper {
    int deleteByPrimaryKey(Integer id);

    int insert(User record);

    int insertSelective(User record);

    User selectByPrimaryKey(Integer id);

    int updateByPrimaryKeySelective(User record);

    int updateByPrimaryKey(User record);

    List<User> getUserAll();
}

PageResultBean和ResultBean的代碼在GitHub

GitHub：https://github.com/cuifuan/springboot-demo

實體層和mapper.xml代碼都是可以自動生成的

教程導航：https://mp.weixin.qq.com/s/T1gdEYWD62w7C8P_Ry8Jgw

4.了解RESTful

通過上面的編碼，如果你已經走通了上面的代碼，相信你已經對REST有了大緻的掌握，時今當下的前端Client層出不窮，後端接口或許來自不同平台，這時候需要請求一批接口，而RESTful風格的api，使人從請求方式和位址一看就知道是要做什麼操作，根據傳回code狀态就知道結果如何

使用RESTful直接帶來的便利：

之前的接口

删除 /user/delete
添加 /user/create
單個查詢 /user/queryById
查詢全部 /user/queryAll
更新 /user/update

采用RESTful設計API之後

/user/api一個URL位址解決，再也不用跟前端廢舌頭了，同時GET請求是幂等的，什麼是幂等？簡單通俗的說就是多次請求傳回的效果都是相同的，例如GET去請求一個資源，無論請求多少次，都不會對資料造成建立修改等操作，PUT用來更新資料也是，無論執行多次的都是最終一樣的效果

SpringBoot2.x【六】整合 Rest API 接口規範SpringBoot2.x【六】整合 Rest API 接口規範

SpringBoot2.x【六】整合 Rest API 接口規範

1.REST簡短介紹

2.準備工作

3.開始

HTTP GET請求/user/api 查詢全部

HTTP GET請求/user/api/65 跟據id查詢

HTTP POST請求/user/api 建立使用者

HTTP PUT請求/user/api/65 來更新使用者資訊

HTTP DELETE請求/user/api/85 來删除id為85的使用者

4.業務層及dao層代碼

4.了解RESTful

繼續閱讀

關于Gradle配置的小結

Java小案例——随機數猜測随機數猜測

nginx location中斜線的位置的重要性

27 Best Free Eclipse Plug-ins for Java Developer to be ProductiveCode Quality PluginsText Editor PluginsDependency ManagementVersion Control Integration PluginsFramework Development Continuous Integration Related PluginsOther Utility Plugins

Java String.format方法的簡單使用

neo4j之cypher使用文檔

GitHub連夜封殺！這份阿裡 10W 字内部 Java 字面試手冊到底有多強？

spark/scala關于【資源檔案】加載方法概述外部檔案加載方案測試資源檔案打包入jar包中小結

mybatis_入門程式Mybatis入門

AOP程式設計_Android優雅權限架構(1)概念基礎，2021金三銀四前言正文大綱正文

Effective Java 8:通用程式設計

OOM三種類型

工廠模式-三種類型

【遞歸】高效率求2的n次幂

win10本地scala和spark安裝安裝scala安裝spark

scala (3) Function 和 Method