IDEA搭建SpringBoot離線工程的方法

更新時(shí)間：2020年06月28日 09:44:19 作者：一只土肥圓的猿

這篇文章主要介紹了IDEA搭建SpringBoot離線工程的方法，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

SpringBoot的具體介紹可以參看其他網(wǎng)上介紹，這里就不多說(shuō)了，就這幾天的學(xué)習(xí)，個(gè)人理解，簡(jiǎn)而言之：

（1）它是Spring的升級(jí)版，Spring容器能做到的事情，它都能做到，而且更簡(jiǎn)便，從配置形式上來(lái)說(shuō)，SpringBoot完全拋棄了繁瑣的XML文件配置方式，而是替代性地用注解方式來(lái)實(shí)現(xiàn)，雖然本質(zhì)來(lái)說(shuō)，是差不多的（類似包掃描，注解掃描，類加載之類）。

（2）SpringBoot集成的插件更多，從而使用很多服務(wù)，都只是引入一個(gè)依賴，幾個(gè)注解和Java類就可以用了，具體的參考相關(guān)手冊(cè)。

（3）在Web應(yīng)用開(kāi)發(fā)這一塊，之前的應(yīng)用一般來(lái)說(shuō)是打包成war包，再發(fā)布到相關(guān)服務(wù)器容器下（例如Tomcat），雖然SpringBoot也可以這么做，但在SpringBoot下更常見(jiàn)的形式是將SpringBoot應(yīng)用打包成可執(zhí)行jar包文件。之所以這么做，源于你可以直接將SpringBoot應(yīng)用看成是一個(gè)Java Application，其Web應(yīng)用可以沒(méi)有webapp目錄（更不用說(shuō)web.xml了），它推薦使用html頁(yè)面，并將其作為靜態(tài)資源使用。

下面具體記錄一下，如何在IDEA下從零開(kāi)始，一步步搭建SpringBoot Web應(yīng)用，這里采用的是maven作依賴管理，新手起步，有任何疑問(wèn)，請(qǐng)參考SpringBoot官網(wǎng)。

需要說(shuō)明的是SpringBoot依賴的JDK版本為1.8及以上。

（1）File->new,選擇maven，創(chuàng)建一個(gè)空項(xiàng)目，直接next.

（2）填寫工程名

（3）next到底，成果創(chuàng)建一個(gè)基于maven的空J(rèn)ava項(xiàng)目，其目錄結(jié)構(gòu)是這樣的：

（4）在pom文件中引入SpringBoot相關(guān)依賴

<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）新建一個(gè)controller 包，用于存放所有的controller，這里跟官方的一樣，使用SampleController為第一個(gè)測(cè)試用例。代碼如下：

/**
 * Created by Song on 2017/2/15.
 * 官方示例工程中的測(cè)試代碼
 */
@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);
  }
}

注意到，這里有一個(gè)main函數(shù)，再聯(lián)想到前面說(shuō)的，SpringBoot應(yīng)用一般是打包成可執(zhí)行jar包來(lái)發(fā)布的，這個(gè)main函數(shù)就是整個(gè)項(xiàng)目的入口。而之所以能這么做，是因?yàn)镾pringBoot連Tomcat8作為一個(gè)插件都集成進(jìn)去了，所以就不必跟之前的SSM架構(gòu)下一樣，還需要去在Tomcat下配置war包才能運(yùn)行。直接點(diǎn)擊運(yùn)行該main函數(shù)，再瀏覽器鏈接欄，輸入地址http://localhost:8080/，就可以看到打印的字符串”Hello World!”了。這就是官網(wǎng)提供的一個(gè)最基本的基于SpringBoot的Web應(yīng)用，如此便捷。

當(dāng)然，一個(gè)基本的Web應(yīng)用，結(jié)構(gòu)肯定不會(huì)這么簡(jiǎn)單。下面要說(shuō)的是，如何在上面的基礎(chǔ)上，搭建一個(gè)具有MVC結(jié)構(gòu)的完整的Web應(yīng)用，其中數(shù)據(jù)庫(kù)采用的是Mysql，ORM采用的是Spring Data JPA，前端頁(yè)面采用js+html5。（當(dāng)然還有其他的方式，例如ORM框架采用mybatis等，本文暫未涉及。）

（6）在resource目錄下新建一個(gè)application.properties文件（或yml文件）,命名與位置為SpringBoot默認(rèn)的配置文件。在該文件中，記錄著所有的模塊配置內(nèi)容。例如Tomcat的端口（默認(rèn)8080）以及編碼方式等：

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

（7）引入本項(xiàng)目中所需要的相關(guān)依賴(MySQL連接驅(qū)動(dòng) 以及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數(shù)據(jù)庫(kù)連接信息
這里的數(shù)據(jù)庫(kù)為本地?cái)?shù)據(jù)庫(kù)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
這一段的意思就是說(shuō)，數(shù)據(jù)庫(kù)類型為MYSQL，日志信息打印具體執(zhí)行的sql語(yǔ)句，表更新策略以及Java類到數(shù)據(jù)庫(kù)表字段的映射規(guī)則等，具體查看網(wǎng)絡(luò)資料。

#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）編寫一個(gè)實(shí)體類User
@Table標(biāo)簽，指定數(shù)據(jù)庫(kù)中對(duì)應(yīng)的表名，id配置為主鍵，生成策略為自動(dòng)生成

/**
 * 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，實(shí)現(xiàn)DAO層（即數(shù)據(jù)庫(kù)數(shù)據(jù)的增刪改查操作）
新建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接口，兩個(gè)泛型參數(shù)分別代表Java POJO類以及主鍵數(shù)據(jù)類型。我們創(chuàng)建自己的數(shù)據(jù)庫(kù)操作接口時(shí)，只需繼承上述JPA提供的某個(gè)接口，即可自動(dòng)繼承相關(guān)數(shù)據(jù)操作方法，而不需要再次實(shí)現(xiàn)。例如CrudRepositoty提供了對(duì)增刪改查操作的實(shí)現(xiàn)，PagingAndSortingRepository提供了分頁(yè)查詢方法的實(shí)現(xiàn)。另外JPA提供了一套命名規(guī)則例如readBy**()等，這些方法也只需要用戶申明而由JPA自動(dòng)實(shí)現(xiàn)了。如果這仍不能滿足業(yè)務(wù)需求，也可以自定義SQL查詢語(yǔ)句，例如上述代碼所示，采用@Query標(biāo)簽，其中：*語(yǔ)法為引用下面用@Param標(biāo)識(shí)的變量，需要注意的是其中User不是表面而是Java POJO類名。具體使用參考JPA使用手冊(cè)。

（12）設(shè)計(jì)Service層業(yè)務(wù)代碼

新建UserService類，其源代碼如下：

/**
 * Created by Song on 2017/2/15.
 * User業(yè)務(wù)邏輯
 */
@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）設(shè)計(jì)Controller層

新建UserController.java，提供兩個(gè)接口，/user/index 返回頁(yè)面，/user/show返回?cái)?shù)據(jù)。其源代碼如下：

/**
 * 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文件中配置頁(yè)面引擎。這里采用SpringMVC（SpringBoot還提供thymeleaf，freemaker等）。這里需要配置其靜態(tài)資源（js、css文件、圖片文件等）路徑，以及html頁(yè)面文件路徑，參考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）中返回了一個(gè)“user/index”頁(yè)面，所以在templates下新建user目錄，在user目錄下新建index.html頁(yè)面，這里就不寫什么了，默認(rèn)頁(yè)面，通過(guò)相對(duì)路徑引入js文件，js文件里只做示意，彈出一個(gè)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
新建一個(gè)configuration包，用于存放項(xiàng)目配置類。類似SSM架構(gòu)下，spring需要配置Java POJO類包路徑以及DAO層接口路徑，以自動(dòng)掃描相關(guān)注解，這里同樣需要配置這兩項(xiàng)，不同的是Spring采取的是xml配置方式，這里用Java代碼+注解方式配置。新建一個(gè)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）配置項(xiàng)目啟動(dòng)入口

到這一步就可以刪掉（5）中官方示例給出的SampleController.java了，由于我們的工程結(jié)構(gòu)已經(jīng)發(fā)生了改變，我們需要告訴SpringBoot框架去掃描哪些包從而加載對(duì)應(yīng)類，所以這里重新編寫main函數(shù)。新建一個(gè)Entry.java類，其代碼如下（其中@SpringBootApplication是一個(gè)復(fù)合注解，就理解為自動(dòng)配置吧）：

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

（18）運(yùn)行main函數(shù)，訪問(wèn)http://localhost:8080/user/index 會(huì)顯示測(cè)試頁(yè)面，并彈出alert(),訪問(wèn)http://localhost:8080/user/show?name=**(數(shù)據(jù)表里存在的數(shù)據(jù))會(huì)顯示user信息。最終的工程文件結(jié)構(gòu)如下：