入門起步
Spring Boot是Spring社區較新的一個項目。該項目的目的是幫助開發者更容易的創建基於Spring的應用程序和服務,讓更多人的人更快的對Spring進行入門體驗,讓Java開發也能夠實現Ruby on Rails那樣的生產效率。爲Spring生態系統提供了一種固定的、約定優於配置風格的框架。
本教程作者爲「isea533」已經授權發佈,歡迎點擊閱讀原文關注作者博客。
Spring Boot 具有如下特性:
- 爲基於Spring的開發提供更快的入門體驗
- 開箱即用,沒有代碼生成,也無需XML配置。同時也可以修改默認值來滿足特定的需求。
- 提供了一些大型項目中常見的非功能性特性,如嵌入式服務器、安全、指標,健康檢測、外部配置等。
- Spring Boot並不是不對Spring功能上的增強,而是提供了一種快速使用Spring的方式。
Spring Boot 系列
- Spring Boot 入門
- Spring Boot 屬性配置和使用
- Spring Boot 集成MyBatis
- Spring Boot 靜態資源處理
- Spring Boot - 配置排序依賴技巧
- Spring Boot - DevTools 介紹
Spring Boot 教程系列大致分爲上方六篇文章,會陸續更新。後續教程,請關注微信公衆號「Web項目聚集地」
本文根據官方文檔深入講解一段代碼
簡單例子
Spring Boot建議使用Maven或Gradle,本文以Maven爲例。
首先創建一個一般的Maven項目,有一個pom.xml和基本的src/main/java
結構。
在pom.xml
中寫上如下內容:
<?xml version="1.0" encoding="UTF-8"?><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.github.abel533</groupId> <artifactId>spring-boot</artifactId> <version>1.0-SNAPSHOT</version> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>1.3.0.RELEASE</version> </parent> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> <dependencies> <dependency> <groupId>org.springframework</groupId> <artifactId>springloaded</artifactId> <version>1.2.5.RELEASE</version> </dependency> </dependencies> </plugin> </plugins> </build></project>
首先是增加了<parent>
增加父pom比較簡單,而且spring-boot-starter-parent
包含了大量配置好的依賴管理,在自己項目添加這些依賴的時候不需要寫<version>
版本號。
使用父pom雖然簡單,但是有些情況我們已經有父pom,不能直接增加<parent>
時,可以通過如下方式:
<dependencyManagement> <dependencies> <dependency> <!-- Import dependency management from Spring Boot --> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-dependencies</artifactId> <version>1.2.3.RELEASE</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies></dependencyManagement>
java.version屬性
上面pom.xml雖然沒有出現這個屬性,這裏要特別提醒。
Spring默認使用jdk1.6,如果你想使用jdk1.8,你需要在pom.xml
的屬性裏面添加java.version
,如下:
<properties> <java.version>1.8</java.version> </properties>
添加spring-boot-starter-web依賴
Spring通過添加spring-boot-starter-*
這樣的依賴就能支持具體的某個功能。
我們這個示例最終是要實現web功能,所以添加的是這個依賴。
更完整的功能列表可以查看:using-boot-starter-poms
添加spring-boot-maven-plugin插件
該插件支持多種功能,常用的有兩種,第一種是打包項目爲可執行的jar包。
在項目根目錄下執行mvn package
將會生成一個可執行的jar包,jar包中包含了所有依賴的jar包,只需要這一個jar包就可以運行程序,使用起來很方便。該命令執行後還會保留一個XXX.jar.original
的jar包,包含了項目中單獨的部分。
生成這個可執行的jar包後,在命令行執行java -jar xxxx.jar
即可啓動項目。
另外一個命令就是mvn spring-boot:run
,可以直接使用tomcat
(默認)啓動項目。
在我們開發過程中,我們需要經常修改,爲了避免重複啓動項目,我們可以啓用熱部署。
Spring-Loaded
項目提供了強大的熱部署功能,添加/刪除/修改 方法/字段/接口/枚舉 等代碼的時候都可以熱部署,速度很快,很方便。
想在Spring Boot
中使用該功能非常簡單,就是在spring-boot-maven-plugin
插件下面添加依賴:
<dependencies> <dependency> <groupId>org.springframework</groupId> <artifactId>springloaded</artifactId> <version>1.2.5.RELEASE</version> </dependency> </dependencies>
添加以後,通過mvn spring-boot:run
啓動就支持熱部署了。
注意:使用熱部署的時候,需要IDE編譯類後才能生效,你可以打開自動編譯功能,這樣在你保存修改的時候,類就自動重新加載了。
創建一個應用類
我們創建一個Application
類:
@RestController @EnableAutoConfiguration public class Application { @RequestMapping("/") String home() { return "Hello World!"; } @RequestMapping("/now") String hehe() { return "現在時間:" + (new Date()).toLocaleString(); } public static void main(String[] args) { SpringApplication.run(Example.class, args); } }
注意
Spring Boot建議將我們main
方法所在的這個主要的配置類配置在根包名下。
類似如下結構:
com +- example +- myproject +- Application.java | +- domain | +- Customer.java | +- CustomerRepository.java | +- service | +- CustomerService.java | +- web +- CustomerController.java
在Application.java
中有main
方法。
因爲默認和包有關的註解,默認包名都是當前類所在的包,例如@ComponentScan, @EntityScan, @SpringBootApplication
註解。
@RestController
因爲我們例子是寫一個web應用,因此寫的這個註解,這個註解相當於同時添加@Controller
和@ResponseBody
註解。
@EnableAutoConfiguration
Spring Boot建議只有一個帶有該註解的類。
@EnableAutoConfiguration
作用:Spring Boot會自動根據你jar包的依賴來自動配置項目。例如當你項目下面有HSQLDB
的依賴時,Spring Boot會創建默認的內存數據庫的數據源DataSource
,如果你自己創建了DataSource
,Spring Boot就不會創建默認的DataSource。
如果你不想讓Spring Boot自動創建,你可以配置註解的exclude
屬性,例如:
@Configuration @EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class}) public class MyConfiguration { }
@SpringBootApplication
由於大量項目都會在主要的配置類上添加@Configuration,@EnableAutoConfiguration,@ComponentScan
三個註解。
因此Spring Boot提供了@SpringBootApplication
註解,該註解可以替代上面三個註解(使用Spring註解繼承實現)。
home等方法
@RequestMapping("/") String home() { return "Hello World!"; } @RequestMapping("/now") String hehe() { return "現在時間:" + (new Date()).toLocaleString(); }
這些方法都添加了@RequestMapping("xxx")
,這個註解起到路由的作用。
啓動項目SpringApplication.run
啓動Spring Boot項目最簡單的方法就是執行下面的方法:
SpringApplication.run(Application.class, args);
該方法返回一個ApplicationContext
對象,使用註解的時候返回的具體類型是AnnotationConfigApplicationContext
或AnnotationConfigEmbeddedWebApplicationContext
,當支持web的時候是第二個。
除了上面這種方法外,還可以用下面的方法:
SpringApplication application = new SpringApplication(Application.class); application.run(args);
SpringApplication
包含了一些其他可以配置的方法,如果你想做一些配置,可以用這種方式。
除了上面這種直接的方法外,還可以使用SpringApplicationBuilder:
new SpringApplicationBuilder() .showBanner(false) .sources(Application.class) .run(args);
當使用SpringMVC的時候由於需要使用子容器,就需要用到SpringApplicationBuilder
,該類有一個child(xxx...)
方法可以添加子容器。
運行
在IDE中直接直接執行main方法,然後訪問http://localhost:8080
即可。
另外還可以用上面提到的mvn
,可以打包爲可執行jar包,然後執行java -jar xxx.jar。
或者執行mvn spring-boot:run
運行項目。
項目啓動後輸出如下日誌:
[INFO] Attaching agents: [F:\.m2\repository\org\springframework\springloaded\1.2.5.RELEASE\springloaded-1.2.5.RELEASE.jar] . ____ _ __ _ _ /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \ \\/ ___)| |_)| | | | | || (_| | ) ) ) ) ' |____| .__|_| |_|_| |_\__, | / / / / =========|_|==============|___/=/_/_/_/ :: Spring Boot :: (v1.2.3.RELEASE) 2015-12-12 22:26:35.298 INFO 9844 --- [ main] c.github.abel533.springboot.Application : Starting Application on liuzh-PC with PID 9844 (F:\Liu\IDEA\SpringBoot\spring-boot\target\classes started by liuzh_3nofxnp in F:\Liu\IDEA\SpringBoot\spring-boot) 2015-12-12 22:26:35.332 INFO 9844 --- [ main] ationConfigEmbeddedWebApplicationContext : Refreshing org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext@a38d7a3: startup date [Sat Dec 12 22:26:35 CST 2015]; root of context hierarchy 2015-12-12 22:26:35.734 INFO 9844 --- [ main] o.s.b.f.s.DefaultListableBeanFactory : Overriding bean definition for bean 'beanNameViewResolver': replacing [Root bean: class [null]; scope=; abstract=false; lazyInit=false; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=org.springframework.boot.autoconfigure.web.ErrorMvcAutoConfiguration$WhitelabelErrorViewConfiguration; factoryMethodName=beanNameViewResolver; initMethodName=null; destroyMethodName=(inferred); defined in class path resource [org/springframework/boot/autoconfigure/web/ErrorMvcAutoConfiguration$WhitelabelErrorViewConfiguration.class]] with [Root bean: class [null]; scope=; abstract=false; lazyInit=false; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=org.springframework.boot.autoconfigure.web.WebMvcAutoConfiguration$WebMvcAutoConfigurationAdapter; factoryMethodName=beanNameViewResolver; initMethodName=null; destroyMethodName=(inferred); defined in class path resource [org/springframework/boot/autoconfigure/web/WebMvcAutoConfiguration$WebMvcAutoConfigurationAdapter.class]] 2015-12-12 22:26:36.302 INFO 9844 --- [ main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat initialized with port(s): 8080 (http) 2015-12-12 22:26:36.456 INFO 9844 --- [ main] o.apache.catalina.core.StandardService : Starting service Tomcat 2015-12-12 22:26:36.457 INFO 9844 --- [ main] org.apache.catalina.core.StandardEngine : Starting Servlet Engine: Apache Tomcat/8.0.20 2015-12-12 22:26:36.537 INFO 9844 --- [ost-startStop-1] o.a.c.c.C.[Tomcat].[localhost].[/] : Initializing Spring embedded WebApplicationContext 2015-12-12 22:26:36.537 INFO 9844 --- [ost-startStop-1] o.s.web.context.ContextLoader : Root WebApplicationContext: initialization completed in 1207 ms 2015-12-12 22:26:36.941 INFO 9844 --- [ost-startStop-1] o.s.b.c.e.ServletRegistrationBean : Mapping servlet: 'dispatcherServlet' to [/] 2015-12-12 22:26:36.944 INFO 9844 --- [ost-startStop-1] o.s.b.c.embedded.FilterRegistrationBean : Mapping filter: 'characterEncodingFilter' to: [/*] 2015-12-12 22:26:36.945 INFO 9844 --- [ost-startStop-1] o.s.b.c.embedded.FilterRegistrationBean : Mapping filter: 'hiddenHttpMethodFilter' to: [/*] 2015-12-12 22:26:37.111 INFO 9844 --- [ main] s.w.s.m.m.a.RequestMappingHandlerAdapter : Looking for @ControllerAdvice: org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext@a38d7a3: startup date [Sat Dec 12 22:26:35 CST 2015]; root of context hierarchy 2015-12-12 22:26:37.152 INFO 9844 --- [ main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/],methods=[],params=[],headers=[],consumes=[],produces=[],custom=[]}" onto java.lang.String com.github.abel533.springboot.Application.home() 2015-12-12 22:26:37.152 INFO 9844 --- [ main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/now],methods=[],params=[],headers=[],consumes=[],produces=[],custom=[]}" onto java.lang.String com.github.abel533.springboot.Application.hehe() 2015-12-12 22:26:37.156 INFO 9844 --- [ main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/error],methods=[],params=[],headers=[],consumes=[],produces=[],custom=[]}" onto public org.springframework.http.ResponseEntity<java.util.Map<java.lang.String, java.lang.Object>> org.springframework.boot.autoconfigure.web.BasicErrorController.error(javax.servlet.http.HttpServletRequest) 2015-12-12 22:26:37.156 INFO 9844 --- [ main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/error],methods=[],params=[],headers=[],consumes=[],produces=[text/html],custom=[]}" onto public org.springframework.web.servlet.ModelAndView org.springframework.boot.autoconfigure.web.BasicErrorController.errorHtml(javax.servlet.http.HttpServletRequest) 2015-12-12 22:26:37.175 INFO 9844 --- [ main] o.s.w.s.handler.SimpleUrlHandlerMapping : Mapped URL path [/webjars/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler] 2015-12-12 22:26:37.175 INFO 9844 --- [ main] o.s.w.s.handler.SimpleUrlHandlerMapping : Mapped URL path [/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler] 2015-12-12 22:26:37.195 INFO 9844 --- [ main] o.s.w.s.handler.SimpleUrlHandlerMapping : Mapped URL path [/**/favicon.ico] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler] 2015-12-12 22:26:37.237 INFO 9844 --- [ main] o.s.j.e.a.AnnotationMBeanExporter : Registering beans for JMX exposure on startup 2015-12-12 22:26:37.279 INFO 9844 --- [ main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 8080 (http) 2015-12-12 22:26:37.280 INFO 9844 --- [ main] c.github.abel533.springboot.Application : Started Application in 2.181 seconds (JVM running for 2.607)
最後
以上是Spring Boot基礎的內容,有些不全面的地方或者讀者有更多疑問,可以查看Spring Boot完整文檔。本教程作者爲「isea533」,歡迎點擊閱讀原文關注作者博客。