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

時間  2019-11-08
標籤 springboot2.x springboot 整合 rest api 接口 規範 欄目 Spring 简体版
原文   原文鏈接

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

Spring Boot經過提供開箱即用的默認依賴或者轉換來補充Spring REST支持。在Spring Boot中編寫RESTful服務與SpringMVC沒有什麼不一樣。總而言之，基於Spring Boot的REST服務與基於Spring的REST服務徹底相同，只是在咱們引導底層應用程序的方式上有所不一樣。前端

1.REST簡短介紹

REST表明Representational State Transfer. 是一種架構風格，設計風格而不是標準，可用於設計Web服務，能夠從各類客戶端使用.java

基於REST的基本設計，其是根據一組動詞來控制的操做git

  • 建立操做：應使用HTTP POST
  • 查詢操做：應使用HTTP GET
  • 更新操做：應使用HTTP PUT
  • 刪除操做：應使用HTTP DELETE

做爲REST服務開發人員或客戶端，您應該遵照上述標準。github

2.準備工做

項目的環境工具web

  • SpringBoot 2.0.1.RELEASE
  • Gradle 4.7
  • IDEA 2018.2
  • MySQL5.7

項目結構圖spring

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/apiapi

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

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

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：github.com/cuifuan/spr…
實體層和mapper.xml代碼都是能夠自動生成的
教程導航：mp.weixin.qq.com/s/T1gdEYWD6…

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用來更新數據也是，不管執行屢次的都是最終同樣的效果

問題：使用PUT改變學生年齡而且這樣作10次和作了一次，學生的年齡是相同的,是冪等的，那麼若是POST作相同操做，那麼它是如何不是冪等的？

答：由於POST請求會在服務端建立與請求次數相同的服務，假如服務端每次請求服務會存在一個密鑰，那麼這個POST請求就可能不是冪等的，也或許是冪等的，因此POST不是冪等的。

由於PUT請求URL到客戶端定義的URL處完整地建立或替換資源，因此PUT是冪等的。 DELETE請求也是冪等的，用來刪除操做，其實REST就是至關於一個風格規範，注意了，GET請求請不要用在delete操做上，你要問我爲啥不行，你偏要那麼作，其實，整個CRUD操做你也均可以用GET來完成，哈哈，這個只是一個開發的設計風格

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程