基礎SpringBoot與maven專案

根目錄
│  .classpath
│  .project
│  pom.xml
│  README.md
│
├─src
│  ├─main
│  │  ├─java
│  │  │  └─com
│  │  │      └─iamzwhui
│  │  │          └─springboottest
│  │  │              │  GateSpringBootApplication.java
│  │  │              │
│  │  │              └─test
│  │  │                  ├─controller
│  │  │                  │      TestController.java
 

│  │  │                  │      TestRestController.java
│  │  │                  │
│  │  │                  └─service
│  │  ├─resources
│  │  │      application.properties
│  │  │
│  │  └─webapp
│  │      │  test.html
│  │      │
│  │      └─WEB-INF
│  │          ├─js
│  │          └─jsp
│  │                  test.jsp
 

一、建立

1、先建立maven專案

選擇專案型別

• Ctrl+n喚出建立視窗
• 搜尋maven
• 選擇maven project
• 點選next

選擇專案模板

• 勾選create a simple project
• 勾選use default workspace location（不要修改）
• 點選next

完善專案資訊

• group id（專案字首）
  
  • 例如com.iamzwhui
• artifact id（專案名稱）
  
  • 例如SpringBootTest
• version（專案版本）
  
  • 例如0.0.1-SNAPSHOT
• packaging（打包方式）
  
  • 例如war
• 其他（暫時不需要）
• 點選finish

若沒有報錯，則maven專案建立完成

2、往maven新增SpringBoot

新增pom資訊

• 找到當前maven專案的pom.xml檔案
• 新增SpringBoot

<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.iamzwhui</groupId>
    <artifactId>SpringBootTest</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <!--打包格式：SpringBoot使用JSP時需打包為war型別 -->
    <packaging>war</packaging>

    <!--繼承SpringBoot預設的父工程-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.4.0.RELEASE</version>
    </parent>

    <!--配置資訊 ，jdk建議1.7或者以上，使用SprintBoot會少很多麻煩-->
    <properties>
        <java.version>1.7</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <maven.compiler.source>${java.version}</maven.compiler.source>
        <maven.compiler.target>${java.version}</maven.compiler.target>
        <!--<tomcat.version>7.0.52</tomcat.version> --><!-- 如果jdk1.6，需要放開這個版本的tomcat來適配1.6 -->
    </properties>

    <!--依賴管理 -->
    <dependencies>
        <!-- SpringBoot的web元件 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- 熱更新 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>springloaded</artifactId>
            <version>1.2.5.RELEASE</version><!--$NO-MVN-MAN-VER$-->
        </dependency>
        <!-- tomcat 的支援.-->
        <dependency> 
            <groupId>org.springframework.boot</groupId> 
            <artifactId>spring-boot-starter-tomcat</artifactId> 
            <scope>provided</scope> 
        </dependency> 
        <!-- jsp 的支援.-->
        <dependency> 
            <groupId>org.apache.tomcat.embed</groupId> 
            <artifactId>tomcat-embed-jasper</artifactId> 
            <scope>provided</scope> 
        </dependency>
        <dependency>
          <groupId>javax.servlet</groupId>
          <artifactId>jstl</artifactId>
        </dependency>
        <!-- 工具 -->
        <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-devtools</artifactId>
        </dependency>
        <!-- 測試模組 -->
        <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-test</artifactId>
          <scope>test</scope>
        </dependency>
    </dependencies>

    <!--構建外掛 -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

若沒有報錯，則SpringBoot新增完成

• jdk建議1.7或者以上，使用SprintBoot會少很多麻煩

二、設定

1、建立SpringBoot的入口

建立GateSpringBootApplication.java

• 位置為src/main/java/com/iamzwhui/springboottest/GateSpringBootApplication.java
• 添加註解@SpringBootApplication
  
  • 它是一個複合註解，包括以下功能
    
    • @ComponentScan
      
      • 包掃描，掃描當前路徑下所有的@Controller、@Service等
    • @SpringBootConfiguration
      
      • 設定當前類是配置類
      • 會將當前類內以@Bean標記的方法的新增到spring容器中
      • 簡單來說就是可以在這裡加key:value，例如map.put(“username”,”iamzwhui”)
        
@Bean
public Map config() {
Map map = new HashMap();
map.put("username", "iamzwhui");
return map;
}

      • 在其他類可以通過ConfigurableApplicationContext物件獲取到username
    • @EnableAutoConfiguration
      
      • SpringBoot自動配置，想知道詳情可以自行百度，這裡不詳解

實現EmbeddedServletContainerCustomizer

• 可以自定義容器，非必須，想知道詳情可以自行百度，這裡不詳解

繼承SpringBootServletInitializer

• 是spring對servlet初始化元件，想知道詳情可以自行百度，這裡不詳解

具體程式碼如下：

package com.iamzwhui.springboottest;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.context.embedded.ConfigurableEmbeddedServletContainer;
import org.springframework.boot.context.embedded.EmbeddedServletContainerCustomizer;
import org.springframework.boot.web.support.SpringBootServletInitializer;
import org.springframework.stereotype.Controller;

//******************************
//******************************
/**
 * Spring入口類
 * @author iamzwhui
 * @since 20180825
 */
//******************************
//******************************
/**
 * @RestController
 * 是一個複合註解，直接返回json，包括以下功能
 * @ResponseBody
 * @Controller
 * 如果需要返回jsp、html等，請使用@Controller
 */
//@RestController
/**
 * @SpringBootConfiguration
 * 承自@Configuration，標註當前類是配置類
 * 會將當前類內宣告的一個或多個以@Bean註解標記的方法的例項納入到spring容器中，並且例項名就是方法名
 */
//@SpringBootConfiguration
/**
 * @SpringBootApplication
 * 是一個複合註解，包括以下功能
 * @ComponentScan
 * @SpringBootConfiguration
 * @EnableAutoConfiguration
 */
@SpringBootApplication
public class GateSpringBootApplication extends SpringBootServletInitializer implements EmbeddedServletContainerCustomizer {

    /**
     * 標註了@SpringBootApplication
     * 表示這個是Spring應用的入口
     * 是Spring應用的配置起點，可以配置Spring上下文
     * 需要在這個Spring應用的入口類中新增一個main()方法
     * 在main()方法中呼叫Spring Boot的SpringApplication類的run()方法，以啟動該Spring應用
     */
    public static void main(String[] args) {
        SpringApplication.run(GateSpringBootApplication.class, args);
    }

    /**
     * EmbeddedServletContainerCustomizer
     * web容器的例項化，比如tomcat
     * 在這裡可以設定伺服器的配置，比如埠
     */
    public void customize(ConfigurableEmbeddedServletContainer container) {
        container.setPort(8080);
    }

    /**
     * SpringBootServletInitializer
     * 若要展示jsp頁面
     * 則必須繼承SpringBootServletInitializer類重寫裡面的方法
     */
    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
        return builder.sources(GateSpringBootApplication.class);
    }
}

2、建立controller

註解說明

/**
 * class前面設定註解
 * 配置@EnableAutoConfiguration，根據新增的jar依賴自動配置Spring
 * 配置@Controller，則return test，其實返回的是/WEB-INF/jsp/test.jsp
 *      前提是需要配置檔案內容（src/main/source/application.properties）
 *      spring.mvc.view.prefix=/WEB-INF/jsp/
 *      spring.mvc.view.suffix=.jsp
 * 配置@RestController,則返回的直接是test字串
 */

基於@Controller建立TestController

package com.iamzwhui.springboottest.test.controller;

import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

//@RestController
@Controller
//@EnableAutoConfiguration
public class TestController {

    @RequestMapping("/testController")
    public String test(){
        return "test";
    }
}

基於@RestController建立TestRestController

package com.iamzwhui.springboottest.test.controller;

import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
//@Controller
//@EnableAutoConfiguration
public class TestRestController {

    @RequestMapping("/testRestController")
    public String test(){
        return "test";
    }
}

建立前端檔案

• jsp檔案
  
  • 路徑：src/main/webapp/WEB-INF/jsp/test.jsp
  • 內容：
    
<%@ page
language="java"
contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta
http-equiv="Content-Type"
content="text/html; charset=UTF-8">
<title>jsp</title>
</head>
<body>
this is jsp
</body>
</html>

• html檔案
  
  • 路徑：src/main/webapp/test.html
  • 內容：
    
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>html</title>
</head>
<body>
this is html
</body>
</html>


建立配置檔案

• 位置：src/main/source/application.properties
• 內容：

################# 專案  #####################
#訪問的根目錄
#server.context-path=/

################# 伺服器  #####################
#埠
#server.port=8080
#session超時
#server.session-timeout=30
#編碼格式
#server.tomcat.uri-encoding=utf-8

################# jsp  #####################
#這裡添加了之後，在controller裡面return jsp頁面的名稱即可，這裡會預設新增前後綴
#例如return test，其實返回的是/WEB-INF/jsp/test.jsp
spring.mvc.view.prefix=/WEB-INF/jsp/
spring.mvc.view.suffix=.jsp
#關閉預設模板引擎
#spring.thymeleaf.cache=false
#spring.thymeleaf.enabled=false
#server.servlet.jsp.init-parameters.development=true

三、執行

1、執行專案

• 專案右鍵
• 選擇debug as
• 選擇第一個maven build
• 如果之前沒有執行過，需要輸入執行指令
  
  • 第一次，會彈出介面
  • 在name中輸入隨意名稱
    
    • 例如clean and run
  • 在goals中輸入指令
    
    • clean package spring-boot:run（意思是打包執行專案）
  • 點選debug確定即可
  • 專案啟動完成
    
    • console列印：Tomcat started on port(s): 8080 (http)
    • console列印：FrameworkServlet ‘dispatcherServlet’: initialization completed in 34 ms
• 若要修改指令
  
  • 專案右鍵
  • 選擇debug as
  • 選擇底部的debug configuration
  • 左邊看板找到你起的名稱
  • 右邊找到goals修改指令

2、請求專案

測試如下：

請求testRestController

- http://localhost:8080/testRestController
- 返回test字串

請求testController

- http://localhost:8080/testController
- 返回/WEB-INF/jsp/test.jsp頁面

請求html

- http://localhost:8080/test.html
- 返回/webapp/test.html頁面

四、問題