做者:JingQcss
下面是簡單的速記,根據使用場景能夠快速定位到知識點:html
Demo
腳手架項目地址:前端
https://github.com/Vip-Augus/springboot-notejava
Table of Contents generated with DocTocmysql
SpringBoot 速記git
1、引入依賴github
2、配置 Swagger 參數web
1、引入依賴redis
2、配置郵箱的參數spring
3、寫模板和發送內容
1、引用 Redis 依賴
2、參數配置
3、代碼使用
1、添加 mybatis 和 druid 依賴
2、配置數據庫和鏈接池參數
3、其餘 mybatis 配置
@ExceptionHandler 錯誤處理
@ModelAttribute 視圖屬性
常規配置
HTTPS 配置
構建項目
SpringBoot 基礎配置
Spring Boot Starters
@SpringBootApplication
Web 容器配置
@ConfigurationProperties
Profile
@ControllerAdvice 用來處理全局數據
CORS 支持,跨域資源共享
註冊 MVC 攔截器
開啓 AOP 切面控制
整合 Mybatis 和 Druid
整合 Redis
發送 HTML 樣式的郵件
整合 Swagger (API 文檔)
總結
參考資料
相比於使用 IDEA
的模板建立項目,我更推薦的是在 Spring
官網上選擇參數一步生成項目
https://start.spring.io/
咱們只須要作的事情,就是修改組織名和項目名,點擊 Generate the project
,下載到本地,而後使用 IDEA
打開
這個時候,不須要任何配置,點擊 Application
類的 run
方法就能直接啓動項目。
引用自參考資料 1 描述:
「starter的理念:starter 會把全部用到的依賴都給包含進來,避免了開發者本身去引入依賴所帶來的麻煩。須要注意的是不一樣的 starter 是爲了解決不一樣的依賴,因此它們內部的實現可能會有很大的差別,例如 jpa 的 starter 和 Redis 的 starter 可能實現就不同,這是由於 starter 的本質在於 synthesize,這是一層在邏輯層面的抽象,也許這種理念有點相似於 Docker,由於它們都是在作一個「包裝」的操做,若是你知道 Docker 是爲了解決什麼問題的,也許你能夠用 Docker 和 starter 作一個類比。
」
咱們知道在 SpringBoot
中很重要的一個概念就是,「約定優於配置」,經過特定方式的配置,能夠減小不少步驟來實現想要的功能。
例如若是咱們想要使用緩存 Redis
在以前的可能須要經過如下幾個步驟:
在 pom
文件引入特定版本的 redis
在 .properties
文件中配置參數
根據參數,新建一個又一個 jedis
鏈接
定義一個工具類,手動建立鏈接池來管理
經歷了上面的步驟,咱們才能正式使用 Redis
但在 Spring Boot
中,一切由於 Starter
變得簡單
在 pom
文件中引入 spring-boot-starter-data-redis
在 .properties
文件中配置參數
經過上面兩個步驟,配置自動生效,具體生效的 bean
是 RedisAutoConfiguration
,自動配置類的名字都有一個特色,叫作 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
到容器中,而後咱們在應用中就能使用 RedisTemplate
來對緩存進行操做~(還有不少細節沒有細說,例如 @ConditionalOnMissingBean
先留個坑(●´∀`●)ノ)
@Autowired private RedisTemplate redisTemplate; ValueOperations ops2 = redisTemplate.opsForValue(); Book book = (Book) ops2.get("b1");
該註解是加載項目的啓動類上的,並且它是一個組合註解:
@SpringBootConfiguration @EnableAutoConfiguration @ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class), @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) }) public @interface SpringBootApplication {...}
下面是這三個核心註解的解釋:
註解名 | 解釋 |
---|---|
@SpringBootConfiguration | 代表這是一個配置類,開發者能夠在這個類中配置 Bean |
@EnableAutoConfiguration | 表示開啓自動化配置 |
@ComponentScan | 完成包掃描,默認掃描的類位於當前類所在包的下面 |
經過該註解,咱們執行 mian
方法:
SpringApplication.run(SpringBootLearnApplication.class, args);
就能夠啓動一個 SpringApplicaiton
應用了。
配置名 | 解釋 |
---|---|
server.port=8081 | 配置了容器的端口號,默認是 8080 |
server.error.path=/error | 配置了項目出錯時跳轉的頁面 |
server.servlet.session.timeout=30m | session 失效時間,m 表示分鐘,若是不寫單位,默認是秒 s |
server.servlet.context-path=/ | 項目名稱,不配置時默認爲/。配置後,訪問時需加上前綴 |
server.tomcat.uri-encoding=utf-8 | Tomcat 請求編碼格式 |
server.tomcat.max-threads=500 | Tomcat 最大線程數 |
server.tomcat.basedir=/home/tmp | Tomcat 運行日誌和臨時文件的目錄,如不配置,默認使用系統的臨時目錄 |
配置名 | 解釋 |
---|---|
server.ssl.key-store=xxx | 祕鑰文件名 |
server.ssl.key-alias=xxx | 祕鑰別名 |
server.ssl.key-store-password=123456 | 祕鑰密碼 |
想要詳細瞭解如何配置 HTTPS
,能夠參考這篇文章 Spring Boot 使用SSL-HTTPS
這個註解能夠放在類上或者 @Bean
註解所在方法上,這樣 SpringBoot
就可以從配置文件中,讀取特定前綴的配置,將屬性值注入到對應的屬性。
使用例子:
@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
其中,若是對象是列表結構,能夠在配置文件中使用 , 逗號進行分割,而後注入到相應的屬性中。
使用該屬性,能夠快速切換配置文件,在 SpringBoot
默認約定中,不一樣環境下配置文件名稱規則爲 application-{profile}.propertie
,profile
佔位符表示當前環境的名稱。
一、配置 application.properties
spring.profiles.active=dev
二、在代碼中配置 在啓動類的 main
方法上添加 setAdditionalProfiles("{profile}")
;
SpringApplicationBuilder builder = new SpringApplicationBuilder(SpringBootLearnApplication.class); builder.application().setAdditionalProfiles("prod"); builder.run(args);
三、啓動參數配置
java -jar demo.jar --spring.active.profile=dev
@ControllerAdvice
是 @Controller
的加強版。主要用來處理全局數據,通常搭配 @ExceptionHandler
、@ModelAttribute
以及 @InitBinder
使用。
/** * 增強版控制器,攔截自定義的異常處理 * */ @ControllerAdvice public class CustomExceptionHandler { // 指定全局攔截的異常類型,統一處理 @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(); } }
@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
類,經過方法參數中的 Model
均可以獲取 value
對應的屬性
CORS(Cross-Origin Resource Sharing)
,跨域資源共享技術,目的是爲了解決前端的跨域請求。
「引用:當一個資源從與該資源自己所在服務器不一樣的域或端口請求一個資源時,資源會發起一個跨域HTTP請求
」
詳細能夠參考這篇文章-springboot系列文章之實現跨域請求(CORS),這裏只是記錄一下如何使用:
例如在個人先後端分離 demo
中,若是沒有經過 Nginx
轉發,那麼將會提示以下信息:
「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) { // 第二行,響應體添加頭信息(這一行是解決上面的提示) response.setHeader("Access-Control-Allow-Credentials", "true"); return HttpRequestUtils.login(); }
在 MVC
模塊中,也提供了相似 AOP
切面管理的擴展,可以擁有更加精細的攔截處理能力。
核心在於該接口:HandlerInterceptor
,使用方式以下:
/** * 自定義 MVC 攔截器 */ public class MyInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { // 在 controller 方法以前調用 return true; } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { // 在 controller 方法以後調用 } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { // 在 postHandle 方法以後調用 } }
註冊代碼:
/** * 全局控制的 mvc 配置 */ @Configuration public class MyWebMvcConfig implements WebMvcConfigurer { @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new MyInterceptor()) // 表示攔截的 URL .addPathPatterns("/**") // 表示須要排除的路徑 .excludePathPatterns("/hello"); } }
攔截器執行順序:preHandle
-> controller
-> postHandle
-> afterCompletion
,同時須要注意的是,只有 preHandle
方法返回 true
,後面的方法纔會繼續執行。
切面注入是老生常談的技術,以前學習 Spring
時也有了解,能夠參考我以前寫過的文章參考一下:
Spring自定義註解實現AOP
Spring 源碼學習(八) AOP 使用和實現原理
在 SpringBoot
中,使用起來更加簡便,只須要加入該依賴,使用方法與上面同樣。
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency>
SpringBoot
整合數據庫操做,目前主流使用的是 Druid
鏈接池和 Mybatis
持久層,一樣的,starter
提供了簡潔的整合方案
項目結構以下:
<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>
# 數據庫配置 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 監控 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 監控 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.*
本地工程,將 xml
文件放入 resources
資源文件夾下,因此須要加入如下配置,讓應用進行識別:
<build> <resources> <resource> <directory>src/main/resources</directory> <includes> <include>**/*</include> </includes> </resource> </resources> ... </build>
經過上面的配置,我本地開啓了三個頁面的監控:SQL
、 URL
和 Sprint
監控,以下圖:
經過上面的配置,SpringBoot 很方便的就整合了 Druid 和 mybatis,同時根據在 properties
文件中配置的參數,開啓了 Druid
的監控。
但我根據上面的配置,始終開啓不了 session
監控,因此若是須要配置 session
監控或者調整參數具體配置,能夠查看官方網站
我用過 Redis
和 NoSQL
,但最熟悉和經常使用的,仍是 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>
# 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 語言實戰"); 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 語言實戰", 2, "none name", BigDecimal.ONE); ops2.set("b1", book); } return book; }
這裏只是簡單記錄引用和使用方式,更多功能能夠看這裏:
以前也使用過,因此能夠參考這篇文章:
<!-- 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>
# 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
郵箱,須要在郵箱的設置中獲取受權碼,填入上面的 password
中
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("發送郵件失敗"); log.error("發送郵件失敗", 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 語言基礎", 1, "nonename", BigDecimal.TEN)); books.add(new Book("Go 語言實戰", 2, "nonename", BigDecimal.TEN)); books.add(new Book("Go 語言進階", 3, "nonename", BigDecimal.TEN)); context.setVariable("books", books); String mail = templateEngine.process("mailtemplate.html", context); mailService.sendHtmlMail("xxxx@qq.com", "xxxxxxxx@qq.com", "圖書清冊", mail); }
經過上面簡單步驟,就可以在代碼中發送郵件,例如咱們每週要寫週報,統計系統運行狀態,能夠設定定時任務,統計數據,而後自動化發送郵件。
<!-- 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>
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", "=-=@qq.com")) .version("v1.0") .title("API 測試文檔") .license("Apache2.0") .licenseUrl("http://www.apache.org/licenese/LICENSE-2.0") .build()); } }
設置頁面 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
等接口標誌,在網頁查看 API
文檔,參考文檔:Spring Boot實戰:集成Swagger2
這邊總結的整合經驗,只是很基礎的配置,在學習的初期,秉着先跑起來,而後不斷完善和精進學習。
並且單一整合很容易,但多個依賴會出現想不到的錯誤,因此在解決環境問題時遇到不少坑,想要使用基礎的腳手架,能夠嘗試跑我上傳的項目。
數據庫腳本在 resources
目錄的 test.sql
文件中
同時,這篇文章中有不少技術沒有概括到,想要深刻學習的,請關注鬆哥的《Spring Boot + Vue 全棧開發》這本書
一、Spring Boot Starters
二、Spring Boot 使用SSL-HTTPS
三、Spring Boot(07)——ConfigurationProperties介紹
四、springboot系列文章之實現跨域請求(CORS)
五、Spring Data Redis(一)–解析RedisTemplate
六、Spring Boot實戰:集成Swagger2