IDEAL零開始搭建SpringBoot工程

相關內容簡體繁體

IDEAL零開始搭建SpringBoot工程

本文轉載自查看原文 2018-08-24 18:59 950

（1）它是Spring的升級版，Spring容器能做到的事情，它都能做到，而且更簡便，從配置形式上來說，SpringBoot完全拋棄了繁瑣的XML文件配置方式，而是替代性地用注解方式來實現，雖然本質來說，是差不多的（類似包掃描，注解掃描，類加載之類）。
（2）SpringBoot集成的插件更多，從而使用很多服務，都只是引入一個依賴，幾個注解和Java類就可以用了，具體的參考相關手冊。
（3）在Web應用開發這一塊，之前的應用一般來說是打包成war包，再發布到相關服務器容器下（例如Tomcat），雖然SpringBoot也可以這么做，但在SpringBoot下更常見的形式是將SpringBoot應用打包成可執行jar包文件。之所以這么做，源於你可以直接將SpringBoot應用看成是一個Java Application，其Web應用可以沒有webapp目錄（更不用說web.xml了），它推薦使用html頁面，並將其作為靜態資源使用。
下面具體記錄一下，如何在IDEA下從零開始，一步步搭建SpringBoot Web應用，這里采用的是maven作依賴管理，新手起步，有任何疑問，請參考SpringBoot官網。
需要說明的是SpringBoot依賴的JDK版本為1.8及以上。
（1）File->new,選擇maven，創建一個空項目，直接next.

（2）填寫工程名

（3）next到底，成果創建一個基於maven的空Java項目，其目錄結構是這樣的：

（4）在pom文件中引入SpringBoot相關依賴

<parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>1.5.1.RELEASE</version> </parent> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> </dependencies>

（5）新建一個controller 包，用於存放所有的controller，這里跟官方的一樣，使用SampleController為第一個測試用例。代碼如下：

/** * Created by Song on 2017/2/15. * 官方示例工程中的測試代碼 */ @Controller @EnableAutoConfiguration public class SampleController { @RequestMapping("/") @ResponseBody String home() { return "Hello World!"; } public static void main(String[] args) throws Exception { SpringApplication.run(SampleController.class, args); } }

注意到，這里有一個main函數，再聯想到前面說的，SpringBoot應用一般是打包成可執行jar包來發布的，這個main函數就是整個項目的入口。而之所以能這么做，是因為SpringBoot連Tomcat8作為一個插件都集成進去了，所以就不必跟之前的SSM架構下一樣，還需要去在Tomcat下配置war包才能運行。直接點擊運行該main函數，再瀏覽器鏈接欄，輸入地址http://localhost:8080/，就可以看到打印的字符串”Hello World!”了。這就是官網提供的一個最基本的基於SpringBoot的Web應用，如此便捷。
當然，一個基本的Web應用，結構肯定不會這么簡單。下面要說的是，如何在上面的基礎上，搭建一個具有MVC結構的完整的Web應用，其中數據庫采用的是Mysql，ORM采用的是Spring Data JPA，前端頁面采用js+html5。（當然還有其他的方式，例如ORM框架采用mybatis等，本文暫未涉及。）
（6）在resource目錄下新建一個application.properties文件（或yml文件）,命名與位置為SpringBoot默認的配置文件。在該文件中，記錄着所有的模塊配置內容。例如Tomcat的端口（默認8080）以及編碼方式等：

server.port=8080 server.tomcat.uri-encoding=utf-8

（7）引入本項目中所需要的相關依賴(MySQL連接驅動以及Spring Data JPA,thymeleaf模板引擎)

        <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java --> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.39</version> </dependency> <!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-thymeleaf --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-thymeleaf</artifactId> <version>1.4.0.RELEASE</version> </dependency> <!-- https://mvnrepository.com/artifact/org.springframework.data/spring-data-jpa --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-jpa</artifactId> <version>1.5.1.RELEASE</version> </dependency>

（8）在application.properties中配置MySQL數據庫連接信息
這里的數據庫為本地數據庫test,用戶名和密碼改成自己的

#MySQL spring.datasource.driver-class-name=com.mysql.jdbc.Driver spring.datasource.url=jdbc:mysql://localhost:3306/test?characterEncoding=utf8 spring.datasource.username=**** spring.datasource.password=****

（9）在application.properties中配置Spring Data JPA
這一段的意思就是說，數據庫類型為MYSQL，日志信息打印具體執行的sql語句，表更新策略以及Java類到數據庫表字段的映射規則等，具體查看網絡資料。

#Spring Data JPA spring.jpa.database=MYSQL spring.jpa.show-sql=true spring.jpa.hibernate.ddl-auto=update # Naming strategy spring.jpa.hibernate.naming-strategy = org.hibernate.cfg.ImprovedNamingStrategy # stripped before adding them to the entity manager) spring.jpa.properties.hibernate.dialect = org.hibernate.dialect.MySQL5Dialect

（10）編寫一個實體類User
@Table標簽，指定數據庫中對應的表名，id配置為主鍵，生成策略為自動生成

/** * Created by Song on 2017/2/15. * Model 用戶 */ @Entity @Table(name = "tbl_user") public class User { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) private long id; private String name; private String password; }

（11）基於JPA，實現DAO層（即數據庫數據的增刪改查操作）
新建UserRepositoty.java接口文件，源代碼如下：

/** * Created by Song on 2017/2/15. * User表操作接口 */ @Repository public interface UserRepositoty extends JpaRepository<User,Long>{ @Query("select t from User t where t.name = :name") User findByUserName(@Param("name") String name); }

需要解釋的是，Spring Data JPA提供了很多持久層接口，例如Repository,CrudRepositoty,PagingAndSortingRepository 以及JpaRepository 接口。其中Repository為基類，JpaRepository繼承自PagingAndSortingRepository接口，兩個泛型參數分別代表Java POJO類以及主鍵數據類型。我們創建自己的數據庫操作接口時，只需繼承上述JPA提供的某個接口，即可自動繼承相關數據操作方法，而不需要再次實現。例如CrudRepositoty提供了對增刪改查操作的實現，PagingAndSortingRepository提供了分頁查詢方法的實現。另外JPA提供了一套命名規則例如readBy**()等，這些方法也只需要用戶申明而由JPA自動實現了。如果這仍不能滿足業務需求，也可以自定義SQL查詢語句，例如上述代碼所示，采用@Query標簽，其中：*語法為引用下面用@Param標識的變量，需要注意的是其中User不是表面而是Java POJO類名。具體使用參考JPA使用手冊。
（12）設計Service層業務代碼
新建UserService類，其源代碼如下：

/** * Created by Song on 2017/2/15. * User業務邏輯 */ @Service public class UserService { @Autowired private UserRepositoty userRepositoty; public User findUserByName(String name){ User user = null; try{ user = userRepositoty.findByUserName(name); }catch (Exception e){} return user; } }

（13）設計Controller層
新建UserController.java，提供兩個接口，/user/index 返回頁面，/user/show返回數據。其源代碼如下：

/** * Created by Song on 2017/2/15. * User控制層 */ @Controller @RequestMapping(value = "/user") public class UserController { @Autowired private UserService userService; @RequestMapping(value = "/index") public String index(){ return "user/index"; } @RequestMapping(value = "/show") @ResponseBody public String show(@RequestParam(value = "name")String name){ User user = userService.findUserByName(name); if(null != user) return user.getId()+"/"+user.getName()+"/"+user.getPassword(); else return "null"; } }

（14）在application.properties文件中配置頁面引擎。這里采用SpringMVC（SpringBoot還提供thymeleaf，freemaker等）。這里需要配置其靜態資源（js、css文件、圖片文件等）路徑，以及html頁面文件路徑，參考SpringMVC在Spring下的配置。

#視圖層控制 spring.mvc.view.prefix=classpath:/templates/ spring.mvc.view.suffix=.html spring.mvc.static-path-pattern=/static/**

（15）在resource目錄下新建templates以及static目錄，分別用於存放html文件以及（js、css文件、圖片)文件。在（13）中返回了一個“user/index”頁面，所以在templates下新建user目錄，在user目錄下新建index.html頁面，這里就不寫什么了，默認頁面，通過相對路徑引入js文件，js文件里只做示意，彈出一個alert()。
user/index.html

<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"/> <script src="../static/scripts/jquery.min.js"></script> <script src="../static/scripts/test.js"></script> <title>Title</title> </head> <h1>TEST PAGE</h1> <body> </body> </html>

static/scripts/test.js

$(document).ready(function (){ alert("OK TEST"); });

（16）配置JPA
新建一個configuration包，用於存放項目配置類。類似SSM架構下，spring需要配置Java POJO類包路徑以及DAO層接口路徑，以自動掃描相關注解，這里同樣需要配置這兩項，不同的是Spring采取的是xml配置方式，這里用Java代碼+注解方式配置。新建一個JpaConfiguration.java類，其代碼如下：

/** * Created by Song on 2017/2/15. * JPA 配置類 */ @Order(Ordered.HIGHEST_PRECEDENCE) @Configuration @EnableTransactionManagement(proxyTargetClass = true) @EnableJpaRepositories(basePackages = "com.song.repository") @EntityScan(basePackages = "com.song.entity") public class JpaConfiguration { @Bean PersistenceExceptionTranslationPostProcessor persistenceExceptionTranslationPostProcessor(){ return new PersistenceExceptionTranslationPostProcessor(); } }

（17）配置項目啟動入口
到這一步就可以刪掉（5）中官方示例給出的SampleController.java了，由於我們的工程結構已經發生了改變，我們需要告訴SpringBoot框架去掃描哪些包從而加載對應類，所以這里重新編寫main函數。新建一個Entry.java類，其代碼如下（其中@SpringBootApplication是一個復合注解，就理解為自動配置吧）：

/** * Created by Song on 2017/2/15. * 項目啟動入口，配置包根路徑 */ @SpringBootApplication @ComponentScan(basePackages = "com.song") public class Entry { public static void main(String[] args) throws Exception { SpringApplication.run(Entry.class, args); } }

（18）運行main函數，訪問http://localhost:8080/user/index 會顯示測試頁面，並彈出alert(),訪問http://localhost:8080/user/show?name=**(數據表里存在的數據)會顯示user信息。最終的工程文件結構如下：
這里寫圖片描述
完整項目工程：https://github.com/Sonlan/springboot-demo