成人国产在线小视频_日韩寡妇人妻调教在线播放_色成人www永久在线观看_2018国产精品久久_亚洲欧美高清在线30p_亚洲少妇综合一区_黄色在线播放国产_亚洲另类技巧小说校园_国产主播xx日韩_a级毛片在线免费

資訊專欄INFORMATION COLUMN

Spring Boot學(xué)習(xí)筆記（四）構(gòu)建RESTful API標(biāo)準(zhǔn)工程實(shí)例

firim / 3348人閱讀

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

本文主要記錄搭建RESTful API標(biāo)準(zhǔn)工程，包含比較推薦的工程結(jié)構(gòu)，掌握一些基本注解，并引入Swagger
新建一個(gè)項(xiàng)目

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

工程結(jié)構(gòu)

Spring Boot框架對(duì)工程結(jié)構(gòu)并沒有什么特殊的限制，我這邊基本按照網(wǎng)上主流和自己一些喜好進(jìn)行劃分，供參考：

代碼層結(jié)構(gòu)

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

數(shù)據(jù)服務(wù)層(Service): com.xxx.service

實(shí)體（Entity）與數(shù)據(jù)訪問層（Repository）:com.xxx.domain

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

資源文件的結(jié)構(gòu)

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

靜態(tài)文件: src/main/resources/static

模板: src/main/resources/templates

編寫第一個(gè)服務(wù)

在controller下新建類HelloController，相關(guān)代碼做了簡(jiǎn)單的注釋，如下:

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

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

無需配置Tomcat，直接啟動(dòng)，輸入對(duì)應(yīng)的地址可看到結(jié)果：

增加service層

在搭建了基礎(chǔ)應(yīng)用的基礎(chǔ)上，我們?cè)黾觭ervice層抽離控制層和業(yè)務(wù)層代碼。

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

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

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

修改對(duì)應(yīng)的controller代碼：

@Autowired
private HelloService helloService;

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

這樣，簡(jiǎn)單的拆分就完成了。

引入Swagger

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

首先引入對(duì)應(yīng)的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("測(cè)試文檔")
                .description("這里是一段描述")
                .termsOfServiceUrl("http://www.bug2048.com/")
                .version("1.0")
                .build();
    }
}

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

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

至此，簡(jiǎn)單的框架算是完成了，后面就可以逐步完善，包括接入日志，數(shù)據(jù)庫(kù)等等，后面會(huì)持續(xù)更新。

總結(jié)

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

@SpringBootApplication: 申明讓spring boot自動(dòng)給程序進(jìn)行必要的配置。

@RestController:REST風(fēng)格的控制器

@RequestMapping:提供路由信息，負(fù)責(zé)URL到Controller中的具體函數(shù)的映射

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

@Autowired: 自動(dòng)導(dǎo)入依賴的bean

文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請(qǐng)注明本文地址：http://systransis.cn/yun/68923.html

相關(guān)文章

  • Spring Boot學(xué)習(xí)筆記（六）結(jié)合MyBatis實(shí)現(xiàn)較為復(fù)雜的RESTful API

    摘要：前兩篇已經(jīng)構(gòu)建了標(biāo)準(zhǔn)工程實(shí)例，也整合了實(shí)現(xiàn)了簡(jiǎn)單數(shù)據(jù)庫(kù)訪問，本篇主要更深入的學(xué)習(xí)下，實(shí)現(xiàn)較為完整的數(shù)據(jù)庫(kù)的標(biāo)準(zhǔn)服務(wù)。到這里，最復(fù)雜的數(shù)據(jù)訪問基本就算編寫完了。 前兩篇已經(jīng)構(gòu)建了RESTful API標(biāo)準(zhǔn)工程實(shí)例，也整合了MyBatis實(shí)現(xiàn)了簡(jiǎn)單數(shù)據(jù)庫(kù)訪問，本篇主要更深入的學(xué)習(xí)下，實(shí)現(xiàn)較為完整的數(shù)據(jù)庫(kù)CRUD的標(biāo)準(zhǔn)服務(wù)。 首先看下要實(shí)現(xiàn)的效果吧，完成下面截圖部分的API，除了CRUD之外...

    CntChen 評(píng)論0 收藏0

  • Spring Boot學(xué)習(xí)筆記（五）整合MyBatis實(shí)現(xiàn)數(shù)據(jù)庫(kù)訪問

    摘要：關(guān)閉進(jìn)程問題順利解決。問題泄也是一個(gè)奇葩的問題，百度一下，原來碰到的人挺多，原因就是高版本的驅(qū)動(dòng)會(huì)有數(shù)據(jù)庫(kù)和系統(tǒng)時(shí)區(qū)差異我用的版本是，所以碰到了，修改下配置，執(zhí)行時(shí)區(qū)就可以了或者用回版本，該版本不會(huì)存在時(shí)區(qū)問題。 本文主要在上一篇Spring Boot學(xué)習(xí)筆記（四）構(gòu)建RESTful API標(biāo)準(zhǔn)工程實(shí)例的基礎(chǔ)上，整合MyBatis，實(shí)現(xiàn)簡(jiǎn)單的MySql數(shù)據(jù)庫(kù)訪問 引入依賴 這里主要依賴...

    Tony 評(píng)論0 收藏0

  • Spring Boot 2.x（十）：構(gòu)建優(yōu)雅的RESTful接口

    摘要：滿足這些約束條件和原則的應(yīng)用程序或設(shè)計(jì)就是。需要注意的是，是設(shè)計(jì)風(fēng)格而不是標(biāo)準(zhǔn)。同一個(gè)路徑，因?yàn)檎?qǐng)求方式的不同，而去找尋不同的接口，完成對(duì)資源狀態(tài)的轉(zhuǎn)變。一個(gè)符合風(fēng)格的就可以稱之一個(gè)的接口。 RESTful 相信在座的各位對(duì)于RESTful都是略有耳聞，那么RESTful到底是什么呢？ REST（Representational State Transfer）表述性狀態(tài)轉(zhuǎn)移是一組架構(gòu)約...

    nevermind 評(píng)論0 收藏0

  • Spring Security

    摘要：框架具有輕便，開源的優(yōu)點(diǎn)，所以本譯見構(gòu)建用戶管理微服務(wù)五使用令牌和來實(shí)現(xiàn)身份驗(yàn)證往期譯見系列文章在賬號(hào)分享中持續(xù)連載，敬請(qǐng)查看在往期譯見系列的文章中，我們已經(jīng)建立了業(yè)務(wù)邏輯數(shù)據(jù)訪問層和前端控制器但是忽略了對(duì)身份進(jìn)行驗(yàn)證。 重拾后端之Spring Boot（四）：使用JWT和Spring Security保護(hù)REST API 重拾后端之Spring Boot（一）：REST API的搭建...

    keelii 評(píng)論0 收藏0

  • Spring Web

    摘要：認(rèn)證鑒權(quán)與權(quán)限控制在微服務(wù)架構(gòu)中的設(shè)計(jì)與實(shí)現(xiàn)一引言本文系認(rèn)證鑒權(quán)與權(quán)限控制在微服務(wù)架構(gòu)中的設(shè)計(jì)與實(shí)現(xiàn)系列的第一篇，本系列預(yù)計(jì)四篇文章講解微服務(wù)下的認(rèn)證鑒權(quán)與權(quán)限控制的實(shí)現(xiàn)。 java 開源項(xiàng)目收集 平時(shí)收藏的 java 項(xiàng)目和工具 某小公司RESTful、共用接口、前后端分離、接口約定的實(shí)踐 隨著互聯(lián)網(wǎng)高速發(fā)展，公司對(duì)項(xiàng)目開發(fā)周期不斷縮短，我們面對(duì)各種需求，使用原有對(duì)接方式，各端已經(jīng)很...

    Kosmos 評(píng)論0 收藏0

發(fā)表評(píng)論

0條評(píng)論

最新活動(dòng)
閱讀需要支付1元查看
<