Spring Boot學習筆記（四）構建RESTful API標準工程實例

firim 發布于2019-08-15 15:12 / 3342人閱讀

摘要：總結基于構建相對來說還是比較便捷的，其中注解使得代碼更加簡潔，本次用到注解再匯總下，有時間的話可以深入理解下其背后的原理申明讓自動給程序進行必要的配置。風格的控制器提供路由信息，負責到中的具體函數的映射一般用于修飾層的組件自動導入依賴的

本文主要記錄搭建RESTful API標準工程，包含比較推薦的工程結構，掌握一些基本注解，并引入Swagger

新建一個項目

通過Spring Initializr創建工程，選擇所需要的jar包，如下圖：

工程結構

Spring Boot框架對工程結構并沒有什么特殊的限制，我這邊基本按照網上主流和自己一些喜好進行劃分，供參考：

代碼層結構

前端控制器(Controller): com.xxx.controller

數據服務層(Service): com.xxx.service

實體（Entity）與數據訪問層（Repository）:com.xxx.domain

公共方法及工具類: com.xxx.common

資源文件的結構

配置文件: src/main/resources/config

靜態文件: src/main/resources/static

模板: src/main/resources/templates

編寫第一個服務

在controller下新建類HelloController，相關代碼做了簡單的注釋，如下:

//相當于 @Controller + @ResponseBody
//該注解 方法method 返回類型是String時候則返回string,返回對象時候則講json_encode 該對象的json字符串
@RestController
public class HelloController {
    //該注解mapping指定路由
    @RequestMapping(value = "/hello",method = RequestMethod.GET)
    public String SayHello() {
        return "Hello Spring Boot";
    }
}

編寫到這里，已經可以直接編譯運行了，這里值得注意的是被@SpringBootApplication注解的啟動類一定要放在所有的RestController的根路徑的package下，@SpringBootApplication只會掃描@SpringBootApplication注解標記類包下及其子包的類，如果不放在根路徑下，可以指定下：@SpringBootApplication(scanBasePackages = "com.example.api_demo")

無需配置Tomcat，直接啟動，輸入對應的地址可看到結果：

增加service層

在搭建了基礎應用的基礎上，我們增加service層抽離控制層和業務層代碼。

在service下新增HelloService和HelloServiceImpl兩個類，代碼如下：

//業務層接口：HelloService
public interface HelloService {
    public String sayHello();
}

//接口實現：HelloServiceImpl
@Service
public class HelloServiceImpl  implements HelloService{
    @Override
    public String sayHello()
    {
        return "Hello Spring Boot";
    }
}

修改對應的controller代碼：

@Autowired
private HelloService helloService;

@RequestMapping(value = "/hello",method = RequestMethod.GET)
public String sayHello()
{
    return helloService.sayHello();
}

這樣，簡單的拆分就完成了。

引入Swagger

Swagger是什么大家自行百度，對于Restful API來說，Swagger絕對是它的好基友。

首先引入對應的jar包，在pom.xml加入：


    io.springfox
    springfox-swagger2
    2.7.0



    io.springfox
    springfox-swagger-ui
    2.7.0

新增類Swagger2.java,代碼如下：

@Configuration
@EnableSwagger2
public class Swagger2 {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.api_demo.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("測試文檔")
                .description("這里是一段描述")
                .termsOfServiceUrl("http://www.bug2048.com/")
                .version("1.0")
                .build();
    }
}

到這里，Swagger就算配置完成了，接下來就是要添加文檔內容了，修改之前的HelloController之后，直接編譯運行，通過/swagger-ui.html就能看到效果

@ApiOperation(value="增加Service層輸出Hello", notes="這是第二個demo")
@RequestMapping(value = "/hello",method = RequestMethod.GET)
public String sayHello()
{
    return helloService.sayHello();
}

至此，簡單的框架算是完成了，后面就可以逐步完善，包括接入日志，數據庫等等，后面會持續更新。

總結

基于Spring Boot構建RESTful API相對來說還是比較便捷的，其中注解使得代碼更加簡潔，本次用到注解再匯總下，有時間的話可以深入理解下其背后的原理：

@SpringBootApplication: 申明讓spring boot自動給程序進行必要的配置。

@RestController:REST風格的控制器

@RequestMapping:提供路由信息，負責URL到Controller中的具體函數的映射

@Service:一般用于修飾service層的組件

@Autowired: 自動導入依賴的bean

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/68923.html

Spring Boot學習筆記（六）結合MyBatis實現較為復雜的RESTful API

摘要：前兩篇已經構建了標準工程實例，也整合了實現了簡單數據庫訪問，本篇主要更深入的學習下，實現較為完整的數據庫的標準服務。到這里，最復雜的數據訪問基本就算編寫完了。前兩篇已經構建了RESTful API標準工程實例，也整合了MyBatis實現了簡單數據庫訪問，本篇主要更深入的學習下，實現較為完整的數據庫CRUD的標準服務。首先看下要實現的效果吧，完成下面截圖部分的API，除了CRUD之外...

CntChen 2019-08-15 15:17 評論0 收藏0
Spring Boot學習筆記（五）整合MyBatis實現數據庫訪問

摘要：關閉進程問題順利解決。問題泄也是一個奇葩的問題，百度一下，原來碰到的人挺多，原因就是高版本的驅動會有數據庫和系統時區差異我用的版本是，所以碰到了，修改下配置，執行時區就可以了或者用回版本，該版本不會存在時區問題。本文主要在上一篇Spring Boot學習筆記（四）構建RESTful API標準工程實例的基礎上，整合MyBatis，實現簡單的MySql數據庫訪問引入依賴這里主要依賴...

Tony 2019-08-15 15:14 評論0 收藏0
Spring Boot 2.x（十）：構建優雅的RESTful接口

摘要：滿足這些約束條件和原則的應用程序或設計就是。需要注意的是，是設計風格而不是標準。同一個路徑，因為請求方式的不同，而去找尋不同的接口，完成對資源狀態的轉變。一個符合風格的就可以稱之一個的接口。 RESTful 相信在座的各位對于RESTful都是略有耳聞，那么RESTful到底是什么呢？ REST（Representational State Transfer）表述性狀態轉移是一組架構約...

nevermind 2019-08-19 10:18 評論0 收藏0
Spring Security

摘要：框架具有輕便，開源的優點，所以本譯見構建用戶管理微服務五使用令牌和來實現身份驗證往期譯見系列文章在賬號分享中持續連載，敬請查看在往期譯見系列的文章中，我們已經建立了業務邏輯數據訪問層和前端控制器但是忽略了對身份進行驗證。重拾后端之Spring Boot（四）：使用JWT和Spring Security保護REST API 重拾后端之Spring Boot（一）：REST API的搭建...

keelii 2019-06-21 16:40 評論0 收藏0
Spring Web

摘要：認證鑒權與權限控制在微服務架構中的設計與實現一引言本文系認證鑒權與權限控制在微服務架構中的設計與實現系列的第一篇，本系列預計四篇文章講解微服務下的認證鑒權與權限控制的實現。 java 開源項目收集平時收藏的 java 項目和工具某小公司RESTful、共用接口、前后端分離、接口約定的實踐隨著互聯網高速發展，公司對項目開發周期不斷縮短，我們面對各種需求，使用原有對接方式，各端已經很...

Kosmos 2019-08-16 11:03 評論0 收藏0