1. <strong id="7actg"></strong>
    2. <table id="7actg"></table>

    3. <address id="7actg"></address>
      <address id="7actg"></address>
      1. <object id="7actg"><tt id="7actg"></tt></object>

        2021最新版 SpringBoot 速記教程

        共 27062字,需瀏覽 55分鐘

         ·

        2021-05-12 16:52

        關(guān)注我們,設(shè)為星標(biāo),每天7:30不見不散,架構(gòu)路上與您共享 

        回復(fù)"架構(gòu)師"獲取資源

        Demo 腳手架項(xiàng)目地址:

        https://github.com/Vip-Augus/springboot-note

        Table of Contents generated with DocToc

        • SpringBoot 速記
          • 一、引入依賴
          • 二、配置 Swagger 參數(shù)
          • 一、引入依賴
          • 二、配置郵箱的參數(shù)
          • 三、寫模板和發(fā)送內(nèi)容
          • 一、引用 Redis 依賴
          • 二、參數(shù)配置
          • 三、代碼使用
          • 一、添加 mybatis 和 druid 依賴
          • 二、配置數(shù)據(jù)庫和連接池參數(shù)
          • 三、其他 mybatis 配置
          • @ExceptionHandler 錯誤處理
          • @ModelAttribute 視圖屬性
          • 常規(guī)配置
          • HTTPS 配置
          • 構(gòu)建項(xiàng)目
          • SpringBoot 基礎(chǔ)配置
          • Spring Boot Starters
          • @SpringBootApplication
          • Web 容器配置
          • @ConfigurationProperties
          • Profile
          • @ControllerAdvice 用來處理全局?jǐn)?shù)據(jù)
          • CORS 支持,跨域資源共享
          • 注冊 MVC 攔截器
          • 開啟 AOP 切面控制
          • 整合 Mybatis 和 Druid
          • 整合 Redis
          • 發(fā)送 HTML 樣式的郵件
          • 整合 Swagger (API 文檔)
          • 總結(jié)
          • 參考資料

        構(gòu)建項(xiàng)目

        相比于使用 IDEA 的模板創(chuàng)建項(xiàng)目,我更推薦的是在 Spring 官網(wǎng)上選擇參數(shù)一步生成項(xiàng)目

        https://start.spring.io/

        我們只需要做的事情,就是修改組織名和項(xiàng)目名,點(diǎn)擊 Generate the project,下載到本地,然后使用 IDEA 打開

        這個時候,不需要任何配置,點(diǎn)擊 Application 類的 run 方法就能直接啟動項(xiàng)目。


        SpringBoot 基礎(chǔ)配置

        Spring Boot Starters

        引用自參考資料 1 描述:

        starter的理念:starter 會把所有用到的依賴都給包含進(jìn)來,避免了開發(fā)者自己去引入依賴所帶來的麻煩。需要注意的是不同的 starter 是為了解決不同的依賴,所以它們內(nèi)部的實(shí)現(xiàn)可能會有很大的差異,例如 jpa 的 starter 和 Redis 的 starter 可能實(shí)現(xiàn)就不一樣,這是因?yàn)?starter 的本質(zhì)在于 synthesize,這是一層在邏輯層面的抽象,也許這種理念有點(diǎn)類似于 Docker,因?yàn)樗鼈兌际窃谧鲆粋€“包裝”的操作,如果你知道 Docker 是為了解決什么問題的,也許你可以用 Docker 和 starter 做一個類比。

        我們知道在 SpringBoot 中很重要的一個概念就是,「約定優(yōu)于配置」,通過特定方式的配置,可以減少很多步驟來實(shí)現(xiàn)想要的功能。

        例如如果我們想要使用緩存 Redis

        在之前的可能需要通過以下幾個步驟:

        1. pom 文件引入特定版本的 redis
        2. .properties 文件中配置參數(shù)
        3. 根據(jù)參數(shù),新建一個又一個 jedis 連接
        4. 定義一個工具類,手動創(chuàng)建連接池來管理

        經(jīng)歷了上面的步驟,我們才能正式使用 Redis

        但在 Spring Boot 中,一切因?yàn)?Starter 變得簡單

        1. pom 文件中引入 spring-boot-starter-data-redis
        2. .properties 文件中配置參數(shù)

        通過上面兩個步驟,配置自動生效,具體生效的 beanRedisAutoConfiguration,自動配置類的名字都有一個特點(diǎn),叫做 xxxAutoConfiguration。

        可以來簡單看下這個類:

        @Configuration
        @ConditionalOnClass(RedisOperations.class)
        @EnableConfigurationProperties(RedisProperties.class)
        @Import({ LettuceConnectionConfiguration.class, JedisConnectionConfiguration.class })
        public class RedisAutoConfiguration {

         @Bean
         @ConditionalOnMissingBean(name = "redisTemplate")
         public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory)
           throws UnknownHostException {
          RedisTemplate<Object, Object> template = new RedisTemplate<>();
          template.setConnectionFactory(redisConnectionFactory);
          return template;
         }

         @Bean
         @ConditionalOnMissingBean
         public StringRedisTemplate stringRedisTemplate(RedisConnectionFactory redisConnectionFactory)
           throws UnknownHostException {
          StringRedisTemplate template = new StringRedisTemplate();
          template.setConnectionFactory(redisConnectionFactory);
          return template;
         }

        }

        @ConfigurationProperties(prefix = "spring.redis")
        public class RedisProperties {...}

        可以看到,Redis 自動配置類,讀取了以 spring.redis 為前綴的配置,然后加載 redisTemplate 到容器中,然后我們在應(yīng)用中就能使用 RedisTemplate 來對緩存進(jìn)行操作~(還有很多細(xì)節(jié)沒有細(xì)說,例如 @ConditionalOnMissingBean 先留個坑(●′?`●)?)

        @Autowired
        private RedisTemplate redisTemplate;

        ValueOperations ops2 = redisTemplate.opsForValue();
        Book book = (Book) ops2.get("b1");

        @SpringBootApplication

        該注解是加載項(xiàng)目的啟動類上的,而且它是一個組合注解:

        @SpringBootConfiguration
        @EnableAutoConfiguration
        @ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
          @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
        public @interface SpringBootApplication {...}

        下面是這三個核心注解的解釋:

        注解名解釋
        @SpringBootConfiguration表明這是一個配置類,開發(fā)者可以在這個類中配置 Bean
        @EnableAutoConfiguration表示開啟自動化配置
        @ComponentScan完成包掃描,默認(rèn)掃描的類位于當(dāng)前類所在包的下面

        通過該注解,我們執(zhí)行 mian 方法:

        SpringApplication.run(SpringBootLearnApplication.class, args);

        就可以啟動一個 SpringApplicaiton 應(yīng)用了。


        Web 容器配置

        常規(guī)配置

        配置名解釋
        server.port=8081配置了容器的端口號,默認(rèn)是 8080
        server.error.path=/error配置了項(xiàng)目出錯時跳轉(zhuǎn)的頁面
        server.servlet.session.timeout=30msession 失效時間,m 表示分鐘,如果不寫單位,默認(rèn)是秒 s
        server.servlet.context-path=/項(xiàng)目名稱,不配置時默認(rèn)為/。配置后,訪問時需加上前綴
        server.tomcat.uri-encoding=utf-8Tomcat 請求編碼格式
        server.tomcat.max-threads=500Tomcat 最大線程數(shù)
        server.tomcat.basedir=/home/tmpTomcat 運(yùn)行日志和臨時文件的目錄,如不配置,默認(rèn)使用系統(tǒng)的臨時目錄

        HTTPS 配置

        配置名解釋
        server.ssl.key-store=xxx秘鑰文件名
        server.ssl.key-alias=xxx秘鑰別名
        server.ssl.key-store-password=123456秘鑰密碼

        想要詳細(xì)了解如何配置 HTTPS,可以參考這篇文章 Spring Boot 使用SSL-HTTPS


        @ConfigurationProperties

        這個注解可以放在類上或者 @Bean 注解所在方法上,這樣 SpringBoot 就能夠從配置文件中,讀取特定前綴的配置,將屬性值注入到對應(yīng)的屬性。

        使用例子:

        @Configuration
        @ConfigurationProperties(prefix = "spring.datasource")
        public class DruidConfigBean {

            private Integer initialSize;

            private Integer minIdle;

            private Integer maxActive;
            
            private List<String> customs;
            
            ...
        }
        application.properties
        spring.datasource.initialSize=5
        spring.datasource.minIdle=5
        spring.datasource.maxActive=20
        spring.datasource.customs=test1,test2,test3

        其中,如果對象是列表結(jié)構(gòu),可以在配置文件中使用 , 逗號進(jìn)行分割,然后注入到相應(yīng)的屬性中。


        Profile

        使用該屬性,可以快速切換配置文件,在 SpringBoot 默認(rèn)約定中,不同環(huán)境下配置文件名稱規(guī)則為 application-{profile}.propertie,profile 占位符表示當(dāng)前環(huán)境的名稱。

        1、配置 application.properties

        spring.profiles.active=dev

        2、在代碼中配置 在啟動類的 main 方法上添加 setAdditionalProfiles("{profile}");

        SpringApplicationBuilder builder = new SpringApplicationBuilder(SpringBootLearnApplication.class);
        builder.application().setAdditionalProfiles("prod");
        builder.run(args);

        3、啟動參數(shù)配置

        java -jar demo.jar --spring.active.profile=dev

        @ControllerAdvice 用來處理全局?jǐn)?shù)據(jù)

        @ControllerAdvice@Controller 的增強(qiáng)版。主要用來處理全局?jǐn)?shù)據(jù),一般搭配 @ExceptionHandler 、@ModelAttribute 以及 @InitBinder 使用。

        @ExceptionHandler 錯誤處理

        /**
         * 加強(qiáng)版控制器,攔截自定義的異常處理
         *
         */
        @ControllerAdvice
        public class CustomExceptionHandler {
            
            // 指定全局?jǐn)r截的異常類型,統(tǒng)一處理
            @ExceptionHandler(MaxUploadSizeExceededException.class)
            public void uploadException(MaxUploadSizeExceededException e, HttpServletResponse response) throws IOException {
                response.setContentType("text/html;charset=utf-8");
                PrintWriter out = response.getWriter();
                out.write("上傳文件大小超出限制");
                out.flush();
                out.close();
            }
        }

        @ModelAttribute 視圖屬性

        @ControllerAdvice
        public class CustomModelAttribute {
            
            // 
            @ModelAttribute(value = "info")
            public Map<String, String> userInfo() throws IOException {
                Map<String, String> map = new HashMap<>();
                map.put("test""testInfo");
                return map;
            }
        }


        @GetMapping("/hello")
        public String hello(Model model) {
            Map<String, Object> map = model.asMap();
            Map<String, String> infoMap = (Map<String, String>) map.get("info");
            return infoMap.get("test");
        }
        • key : @ModelAttribute 注解中的 value 屬性
        • 使用場景:任何請求 controller 類,通過方法參數(shù)中的 Model 都可以獲取 value 對應(yīng)的屬性
        • 關(guān)注公眾號Java后端編程,回復(fù) Java 獲取最新學(xué)習(xí)資料 。

        CORS 支持,跨域資源共享

        CORS(Cross-Origin Resource Sharing),跨域資源共享技術(shù),目的是為了解決前端的跨域請求。

        引用:當(dāng)一個資源從與該資源本身所在服務(wù)器不同的域或端口請求一個資源時,資源會發(fā)起一個跨域HTTP請求

        詳細(xì)可以參考這篇文章-springboot系列文章之實(shí)現(xiàn)跨域請求(CORS),這里只是記錄一下如何使用:

        例如在我的前后端分離 demo 中,如果沒有通過 Nginx 轉(zhuǎn)發(fā),那么將會提示如下信息:

        Access to fetch at ‘http://localhost:8888/login‘ from origin ‘http://localhost:3000‘ has been blocked by CORS policy: Response to preflight request doesn’t pass access control check: The value of the ‘Access-Control-Allow-Credentials’ header in the response is ‘’ which must be ‘true’ when the request’s credentials mode is ‘include’

        為了解決這個問題,在前端不修改的情況下,需要后端加上如下兩行代碼:

        // 第一行,支持的域
        @CrossOrigin(origins = "http://localhost:3000")
        @RequestMapping(value = "/login", method = RequestMethod.GET)
        @ResponseBody
        public String login(HttpServletResponse response) {
            // 第二行,響應(yīng)體添加頭信息(這一行是解決上面的提示)
            response.setHeader("Access-Control-Allow-Credentials""true");
            return HttpRequestUtils.login();
        }

        注冊 MVC 攔截器

        MVC 模塊中,也提供了類似 AOP 切面管理的擴(kuò)展,能夠擁有更加精細(xì)的攔截處理能力。

        核心在于該接口:HandlerInterceptor,使用方式如下:

        /**
         * 自定義 MVC 攔截器
         */
        public class MyInterceptor implements HandlerInterceptor {
            @Override
            public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
                // 在 controller 方法之前調(diào)用
                return true;
            }

            @Override
            public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
                // 在 controller 方法之后調(diào)用
            }

            @Override
            public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
                // 在 postHandle 方法之后調(diào)用
            }
        }

        注冊代碼:

        /**
         * 全局控制的 mvc 配置
         */
        @Configuration
        public class MyWebMvcConfig implements WebMvcConfigurer {
            @Override
            public void addInterceptors(InterceptorRegistry registry) {
                registry.addInterceptor(new MyInterceptor())
                        // 表示攔截的 URL
                        .addPathPatterns("/**")
                        // 表示需要排除的路徑
                        .excludePathPatterns("/hello");
            }
        }

        攔截器執(zhí)行順序:preHandle -> controller -> postHandle -> afterCompletion,同時需要注意的是,只有 preHandle 方法返回 true,后面的方法才會繼續(xù)執(zhí)行。


        開啟 AOP 切面控制

        切面注入是老生常談的技術(shù),之前學(xué)習(xí) Spring 時也有了解,可以參考我之前寫過的文章參考一下:

        Spring自定義注解實(shí)現(xiàn)AOP

        Spring 源碼學(xué)習(xí)(八) AOP 使用和實(shí)現(xiàn)原理

        SpringBoot 中,使用起來更加簡便,只需要加入該依賴,使用方法與上面一樣。

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

        整合 Mybatis 和 Druid

        SpringBoot 整合數(shù)據(jù)庫操作,目前主流使用的是 Druid 連接池和 Mybatis 持久層,同樣的,starter 提供了簡潔的整合方案

        項(xiàng)目結(jié)構(gòu)如下:

        一、添加 mybatis 和 druid 依賴

         <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.2</version>
        </dependency>

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.1.18</version>
        </dependency>

        二、配置數(shù)據(jù)庫和連接池參數(shù)

        # 數(shù)據(jù)庫配置
        spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
        spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
        spring.datasource.url=jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=utf8&allowMultiQueries=true
        spring.datasource.username=root
        spring.datasource.password=12345678

        # druid 配置
        spring.datasource.druid.initial-size=5
        spring.datasource.druid.max-active=20
        spring.datasource.druid.min-idle=5
        spring.datasource.druid.max-wait=60000
        spring.datasource.druid.pool-prepared-statements=true
        spring.datasource.druid.max-pool-prepared-statement-per-connection-size=20
        spring.datasource.druid.max-open-prepared-statements=20
        spring.datasource.druid.validation-query=SELECT 1
        spring.datasource.druid.validation-query-timeout=30000
        spring.datasource.druid.test-on-borrow=true
        spring.datasource.druid.test-on-return=false
        spring.datasource.druid.test-while-idle=false
        #spring.datasource.druid.time-between-eviction-runs-millis=
        #spring.datasource.druid.min-evictable-idle-time-millis=
        #spring.datasource.druid.max-evictable-idle-time-millis=10000

        # Druid stat filter config
        spring.datasource.druid.filters=stat,wall
        spring.datasource.druid.web-stat-filter.enabled=true
        spring.datasource.druid.web-stat-filter.url-pattern=/*
        # session 監(jiān)控
        spring.datasource.druid.web-stat-filter.session-stat-enable=true
        spring.datasource.druid.web-stat-filter.session-stat-max-count=10
        spring.datasource.druid.web-stat-filter.principal-session-name=admin
        spring.datasource.druid.web-stat-filter.principal-cookie-name=admin
        spring.datasource.druid.web-stat-filter.profile-enable=true
        # stat 監(jiān)控
        spring.datasource.druid.web-stat-filter.exclusions=*.js,*.gif,*.jpg,*.bmp,*.png,*.css,*.ico,/druid/*
        spring.datasource.druid.filter.stat.db-type=mysql
        spring.datasource.druid.filter.stat.log-slow-sql=true
        spring.datasource.druid.filter.stat.slow-sql-millis=1000
        spring.datasource.druid.filter.stat.merge-sql=true
        spring.datasource.druid.filter.wall.enabled=true
        spring.datasource.druid.filter.wall.db-type=mysql
        spring.datasource.druid.filter.wall.config.delete-allow=true
        spring.datasource.druid.filter.wall.config.drop-table-allow=false

        # Druid manage page config
        spring.datasource.druid.stat-view-servlet.enabled=true
        spring.datasource.druid.stat-view-servlet.url-pattern=/druid/*
        spring.datasource.druid.stat-view-servlet.reset-enable=true
        spring.datasource.druid.stat-view-servlet.login-username=admin
        spring.datasource.druid.stat-view-servlet.login-password=admin
        #spring.datasource.druid.stat-view-servlet.allow=
        #spring.datasource.druid.stat-view-servlet.deny=
        spring.datasource.druid.aop-patterns=cn.sevenyuan.demo.*

        三、其他 mybatis 配置

        本地工程,將 xml 文件放入 resources 資源文件夾下,所以需要加入以下配置,讓應(yīng)用進(jìn)行識別:

         <build>
            <resources>
                <resource>
                    <directory>src/main/resources</directory>
                    <includes>
                        <include>**/*</include>
                    </includes>
                </resource>
            </resources>
            ...
        </build>

        通過上面的配置,我本地開啟了三個頁面的監(jiān)控:SQL 、 URLSprint 監(jiān)控,如下圖:

        通過上面的配置,SpringBoot 很方便的就整合了 Druid 和 mybatis,同時根據(jù)在 properties 文件中配置的參數(shù),開啟了 Druid 的監(jiān)控。

        但我根據(jù)上面的配置,始終開啟不了 session 監(jiān)控,所以如果需要配置 session 監(jiān)控或者調(diào)整參數(shù)具體配置,可以查看官方網(wǎng)站



        整合 Redis

        我用過 RedisNoSQL,但最熟悉和常用的,還是 Redis ,所以這里記錄一下如何整合

        一、引用 Redis 依賴

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
            <exclusions>
                <exclusion>
                    <artifactId>lettuce-core</artifactId>
                    <groupId>io.lettuce</groupId>
                </exclusion>
            </exclusions>
        </dependency>

        <dependency>
            <groupId>redis.clients</groupId>
            <artifactId>jedis</artifactId>
        </dependency>

        二、參數(shù)配置

        # redis 配置
        spring.redis.database=0
        spring.redis.host=localhost
        spring.redis.port=6379
        spring.redis.password=
        spring.redis.jedis.pool.max-active=8
        spring.redis.jedis.pool.max-idle=8
        spring.redis.jedis.pool.max-wait=-1ms
        spring.redis.jedis.pool.min-idle=0

        三、代碼使用

        @Autowired
        private RedisTemplate redisTemplate;

        @Autowired
        private StringRedisTemplate stringRedisTemplate;

        @GetMapping("/testRedis")
        public Book getForRedis() {
            ValueOperations<String, String> ops1 = stringRedisTemplate.opsForValue();
            ops1.set("name""Go 語言實(shí)戰(zhàn)");
            String name = ops1.get("name");
            System.out.println(name);
            ValueOperations ops2 = redisTemplate.opsForValue();
            Book book = (Book) ops2.get("b1");
            if (book == null) {
                book = new Book("Go 語言實(shí)戰(zhàn)", 2, "none name", BigDecimal.ONE);
                ops2.set("b1", book);
            }
            return book;
        }

        這里只是簡單記錄引用和使用方式,更多功能可以看這里:


        發(fā)送 HTML 樣式的郵件

        之前也使用過,所以可以參考這篇文章:

        一、引入依賴

         <!-- mail -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-mail</artifactId>
        </dependency>

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

        二、配置郵箱的參數(shù)

        # mail
        spring.mail.host=smtp.qq.com
        spring.mail.port=465
        spring.mail.username=xxxxxxxx
        spring.mail.password=xxxxxxxx
        spring.mail.default-encoding=UTF-8
        spring.mail.properties.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory
        spring.mail.properties.mail.debug=true

        如果使用的是 QQ 郵箱,需要在郵箱的設(shè)置中獲取授權(quán)碼,填入上面的 password

        三、寫模板和發(fā)送內(nèi)容

        MailServiceImpl.java
        @Autowired
        private JavaMailSender javaMailSender;

        @Override
        public void sendHtmlMail(String from, String to, String subject, String content) {
            try {
                MimeMessage message = javaMailSender.createMimeMessage();
                MimeMessageHelper helper = new MimeMessageHelper(message, true);
                helper.setFrom(from);
                helper.setTo(to);
                helper.setSubject(subject);
                helper.setText(content, true);
                javaMailSender.send(message);
            } catch (MessagingException e) {
                System.out.println("發(fā)送郵件失敗");
                log.error("發(fā)送郵件失敗", e);
            }
        }
        mailtemplate.html
        <!DOCTYPE html>
        <html lang="en" xmlns:th="http://www.thymeleaf.org">
        <head>
            <meta charset="UTF-8">
            <title>郵件</title>
        </head>
        <body>
        <div th:text="${subject}"></div>
        <div>書籍清單
            <table border="1">
                <tr>
                    <td>圖書編號</td>
                    <td>圖書名稱</td>
                    <td>圖書作者</td>
                </tr>
                <tr th:each="book:${books}">
                    <td th:text="${book.id}"></td>
                    <td th:text="${book.name}"></td>
                    <td th:text="${book.author}"></td>
                </tr>
            </table>
        </div>
        </body>
        </html>
        test.java
        @Autowired
        private MailService mailService;

        @Autowired
        private TemplateEngine templateEngine;
            
        @Test
        public void sendThymeleafMail() {
            Context context = new Context();
            context.setVariable("subject""圖書清冊");
            List<Book> books = Lists.newArrayList();
            books.add(new Book("Go 語言基礎(chǔ)", 1, "nonename", BigDecimal.TEN));
            books.add(new Book("Go 語言實(shí)戰(zhàn)", 2, "nonename", BigDecimal.TEN));
            books.add(new Book("Go 語言進(jìn)階", 3, "nonename", BigDecimal.TEN));
            context.setVariable("books", books);
            String mail = templateEngine.process("mailtemplate.html", context);
            mailService.sendHtmlMail("[email protected]""[email protected]""圖書清冊", mail);
        }

        通過上面簡單步驟,就能夠在代碼中發(fā)送郵件,例如我們每周要寫周報(bào),統(tǒng)計(jì)系統(tǒng)運(yùn)行狀態(tài),可以設(shè)定定時任務(wù),統(tǒng)計(jì)數(shù)據(jù),然后自動化發(fā)送郵件。


        整合 Swagger (API 文檔)

        一、引入依賴

        <!-- swagger -->
        <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>

        二、配置 Swagger 參數(shù)

        SwaggerConfig.java
        @Configuration
        @EnableSwagger2
        @EnableWebMvc
        public class SwaggerConfig {

            @Bean
            Docket docket() {
                return new Docket(DocumentationType.SWAGGER_2)
                        .select()
                        .apis(RequestHandlerSelectors.basePackage("cn.sevenyuan.demo.controller"))
                        .paths(PathSelectors.any())
                        .build().apiInfo(
                                new ApiInfoBuilder()
                                        .description("Spring Boot learn project")
                                        .contact(new Contact("JingQ""https://github.com/vip-augus""[email protected]"))
                                        .version("v1.0")
                                        .title("API 測試文檔")
                                        .license("Apache2.0")
                                        .licenseUrl("http://www.apache.org/licenese/LICENSE-2.0")
                                        .build());

            }
        }

        設(shè)置頁面 UI

        @Configuration
        @EnableRedisHttpSession(maxInactiveIntervalInSeconds = 60)
        public class MyWebMvcConfig implements WebMvcConfigurer {

            @Override
            public void addResourceHandlers(ResourceHandlerRegistry registry) {
                registry.addResourceHandler("swagger-ui.html")
                        .addResourceLocations("classpath:/META-INF/resources/");

                registry.addResourceHandler("/webjars/**")
                        .addResourceLocations("classpath:/META-INF/resources/webjars/");
            }
        }

        通過這樣就能夠識別 @ApiOperation 等接口標(biāo)志,在網(wǎng)頁查看 API 文檔,參考文檔:Spring Boot實(shí)戰(zhàn):集成Swagger2


        總結(jié)

        這邊總結(jié)的整合經(jīng)驗(yàn),只是很基礎(chǔ)的配置,在學(xué)習(xí)的初期,秉著先跑起來,然后不斷完善和精進(jìn)學(xué)習(xí)。

        而且單一整合很容易,但多個依賴會出現(xiàn)想不到的錯誤,所以在解決環(huán)境問題時遇到很多坑,想要使用基礎(chǔ)的腳手架,可以嘗試跑我上傳的項(xiàng)目。

        數(shù)據(jù)庫腳本在 resources 目錄的 test.sql 文件中


        參考資料

        1、Spring Boot Starters

        2、Spring Boot 使用SSL-HTTPS

        3、Spring Boot(07)——ConfigurationProperties介紹

        4、springboot系列文章之實(shí)現(xiàn)跨域請求(CORS)

        5、Spring Data Redis(一)–解析RedisTemplate

        6、Spring Boot實(shí)戰(zhàn):集成Swagger2

        文章來源:http://r6d.cn/X6FP


        到此文章就結(jié)束了。如果今天的文章對你在進(jìn)階架構(gòu)師的路上有新的啟發(fā)和進(jìn)步,歡迎轉(zhuǎn)發(fā)給更多人。歡迎加入架構(gòu)師社區(qū)技術(shù)交流群,眾多大咖帶你進(jìn)階架構(gòu)師,在后臺回復(fù)“加群”即可入群。







        這些年小編給你分享過的干貨

        Kubernetes的前世今生

        你們公司的架構(gòu)師是什么樣的?

        《Docker與CI持續(xù)集成/CD持續(xù)部署》

        《還有40天,Java 11就要橫空出世了》

        《JDK 10 的 109 項(xiàng)新特性》

        《學(xué)習(xí)微服務(wù)的十大理由》

        轉(zhuǎn)發(fā)在看就是最大的支持??

        瀏覽 43
        點(diǎn)贊
        評論
        收藏
        分享

        手機(jī)掃一掃分享

        分享
        舉報(bào)
        評論
        圖片
        表情
        推薦
        點(diǎn)贊
        評論
        收藏
        分享

        手機(jī)掃一掃分享

        分享
        舉報(bào)
        1. <strong id="7actg"></strong>
        2. <table id="7actg"></table>

        3. <address id="7actg"></address>
          <address id="7actg"></address>
          1. <object id="7actg"><tt id="7actg"></tt></object>
            www.抽插| 青娱乐老女人逼特逼 | 久久人妻少妇嫩草AV蜜桃漫画 | 女人被添荫蒂舒服了视频 | 污视频免费网站 | 多人换着伦高h艳妇诱春 | 中国一级特黄大片学生 | 越南一级婬片A片AAA | 青青青国内视频在线观看软件 | 一级婬片A片免费播放桃色 |