spring-boot專案簡單搭建
Spring Boot充分利用了JavaConfig的配置模式以及“約定優於配置”的理念,能夠極大的簡化基於Spring MVC的Web應用和REST服務開發。
要Spring Boot進行功能開發,需要使用Gradle或者Maven作為構建工具。在本例中,我們會使用Eclipse和Maven外掛進行開發。要使用Spring Boot,首先建立一個Maven工程,並修改Maven主要的配置檔案pom.xml,如下所示:
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId >spring-boot-starter-parent</artifactId>
<version>1.2.5.RELEASE</version>
<relativePath/>
</parent>
<!--如果你不使用繼承至parent的spring-boot-starter-parent,通過使用一個scope=import的依賴,你仍能獲取到沒有父POM的Spring Boot
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-dependencies</artifactId>
<version>1.2.5.RELEASE</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
-->
<build>
<finalName>sas-api</finalName>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<warName>sas-api</warName >
</configuration>
</plugin>
</plugins>
</build>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<java.version>1.7</java.version>
<springfox.version>2.2.2</springfox.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<!-- 打包部署到tomcat上面時,不需要打包tmocat相關的jar包,否則會引起jar包衝突 -->
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${springfox.version}</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${springfox.version}</version>
</dependency>
</dependencies>
</project>
在上面的配置中,需要將工程的parent設定為spring-boot-starter-parent,並新增對spring-boot-starter-web的依賴,這樣我們就無需設定各個依賴項及其版本資訊了。並且在構建中要宣告使用spring-boot-maven-plugin這個外掛,它會對Maven打包形成的JAR進行二次修改,最終產生符合我們要求的內容結構。
在我們的應用中將要釋出一個REST服務,顯示一個基本的使用者資訊,首先定義一個簡單的模型類:
public class User {
private Long id;
private String name;
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}
接下來,我們需要宣告一個Spring MVC的Controller,響應對實體的請求:
@RestController
@RequestMapping("/user")
public class UserController {
@RequestMapping("/{id}")
public User view(@PathVariable("id") Long id) {
User user = new User();
user.setId(id);
user.setName("long");
return user;
}
}
這個類與我們在使用Spring MVC定義Controller時並無任何差別。接下來,我們需要宣告一個主類啟動這個應用程式:
@Configuration
@ComponentScan
@EnableAutoConfiguration
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class);
}
}
這個類的main方法中使用了SpringApplication幫助類,並以Application這個類作為配置來啟動Spring的應用上下文。在這個類中使用了ComponentScan以及EnableAutoConfiguration註解,其中ComponentScan註解會告知Spring掃描指定的包來初始化Spring Bean,這能夠確保我們宣告的Bean能夠被發現。
EnableAutoConfiguration將會啟動自動配置模式,在我們的配置中會將對Tomcat的依賴級聯進來,因此在應用啟動時將會自動啟動一個嵌入式的Tomcat,因為在樣例中使用了Spring MVC,所以也會自動註冊所需的DispatcherServlet,這都不需要類似web.xml這樣的配置。
在Eclipse中要執行這個應用的話,可以直接以Java Application的形式來執行這個main函式,此時會啟動應用,我們在瀏覽器中可以看到如下的執行效果,這就是我們想要的REST服務:
在開發除錯完成之後,可以將應用打成JAR包的形式,在Eclipse中可以直接使用Maven外掛的package命令,最終會形成一個可執行的JAR包。我們使用java –jar命令就可以執行這個JAR包了。所呈現出的效果與在除錯期是一樣的。
如果我們想要將這個JAR包轉換成可以在Servlet容器中部署的WAR的話,就不能依賴於Application的main函數了,而是要以類似於web.xml檔案配置的方式來啟動Spring應用上下文,此時我們需要宣告這樣一個類:
public class HelloWebXml extends SpringBootServletInitializer {
@Override
protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
return application.sources(Application.class);
}
}
這個類的作用與在web.xml中配置負責初始化Spring應用上下文的監聽器作用類似,只不過在這裡不需要編寫額外的XML檔案了。
如果要將最終的打包形式改為WAR的話,還需要對pom.xml檔案進行修改,除了需要將packaging的值修改為war以外,還需要對依賴進行適當的配置:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
</exclusion>
</exclusions>
</dependency>
在這裡需要移除對嵌入式Tomcat的依賴,這樣打出的WAR包中,在lib目錄下才不會包含Tomcat相關的JAR包,否則將會出現啟動錯誤。另外,在移除對Tomcat的依賴後,為了保證單獨執行main方法啟動沒問題,還需要新增對spring-boot-starter-tomcat的依賴,因此新增如下的配置:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
<scope>provided</scope>
</dependency>
在這裡將scope屬性設定為provided,這樣在最終形成的WAR中不會包含這個JAR包,因為Tomcat或Jetty等伺服器在執行時將會提供相關的API類。此時,執行mvn package命令就會得到一個WAR檔案,我們可以直接將其放到Tomcat下執行(特別提醒:tomcat必須7.0.42版本以上)。
篇外篇:
正常情況下執行main方法時,是不需要輸入專案名稱就可執行方法url請求。例如:http://localhost:8080/user/6 ;
如果希望main方法也通過專案名訪問,可在resources目錄中新建一個application.properties檔案,裡面新增一句:
server.contextPath=/專案名 (例如:server.contextPath=/sas-api)
這樣main方法啟動,專案會自動去尋找application.properties名稱的配置檔案,如果有,則讀取裡面的配置資訊。,這樣就與部署到tomcat上訪問的url路徑一直了。
http://localhost:8080/sas-api/user/6