天天看點

Spring Boot Controller

版權聲明:本文為部落客原創文章,未經部落客允許不得轉載。 https://blog.csdn.net/catoop/article/details/50501676

接上篇文章,HelloWorld程式中我們已經建立了一個HellController,裡面包含了響應JSON的方法,本文針對Controller再做一下講解。

回顧上篇文章,我們在Controller中使用 @RestController 注解,該注解是Spring 4.0引入的。檢視源碼可知其包含了 @Controller 和 @ResponseBody 注解。我們可以了解為 @Controller的增強版。專門為響應内容式的 Controller 而設計的,可以直接響應對象為JSON。

而 @Controller 用來響應頁面,spring-boot 支援多種模版引擎包括:

1,FreeMarker

2,Groovy

3,Thymeleaf (Spring 官網使用這個)

4,Velocity

5,JSP (貌似Spring Boot官方不推薦,STS建立的項目會在src/main/resources 下有個templates 目錄,這裡就是讓我們放模版檔案的,然後并沒有生成諸如 SpringMVC 中的webapp目錄)

不過本文還是選擇大家都熟悉的JSP來舉例,因為使用JSP與預設支援的模版需要特殊處理,是以拿來舉例更好。

關于Controller 方法可以接收參數使用@RequestBody、@RequestParam、@ModelAttribute、JSONObject、HttpEntity 等方式,皆與Spring的使用一樣,這裡不做贅述。

下面我們來說一下如何使用 @Controller 實作響應JSP頁面(與SpringMVC也是一樣使用)。

建立PageController,編碼如下:

package org.springboot.sample.controller;

import java.util.Date;
import java.util.Map;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

@Controller
public class PageController {

    // 從 application.properties 中讀取配置,如取不到預設值為Hello Shanhy
    @Value("${application.hell:Hello Shanhy}")
    private String hello = "Hello Shanhy";

    /**
     * 預設頁<br/>
     * @RequestMapping("/") 和 @RequestMapping 是有差別的
     * 如果不寫參數,則為全局預設頁,加入輸入404頁面,也會自動通路到這個頁面。
     * 如果加了參數“/”,則隻認為是根頁面。
     *
     * @return
     * @author SHANHY
     * @create  2016年1月5日
     */
    @RequestMapping(value = {"/","/index"})
    public String index(Map<String, Object> model){
        // 直接傳回字元串,架構預設會去 spring.view.prefix 目錄下的 (index拼接spring.view.suffix)頁面
        // 本例為 /WEB-INF/jsp/index.jsp
        model.put("time", new Date());
        model.put("message", this.hello);
        return "index";
    }

    /**
     * 響應到JSP頁面page1
     *
     * @return
     * @author SHANHY
     * @create  2016年1月5日
     */
    @RequestMapping("/page1")
    public ModelAndView page1(){
        // 頁面位置 /WEB-INF/jsp/page/page.jsp
        ModelAndView mav = new ModelAndView("page/page1");
        mav.addObject("content", hello);
        return mav;
    }

    /**
     * 響應到JSP頁面page1(可以直接使用Model封裝内容,直接傳回頁面字元串)
     *
     * @return
     * @author SHANHY
     * @create  2016年1月5日
     */
    @RequestMapping("/page2")
    public String page2(Model model){
        // 頁面位置 /WEB-INF/jsp/page/page.jsp
        model.addAttribute("content", hello + "(第二種)");
        return "page/page1";
    }
}           

pom.xml添加依賴:

<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>           

上面說了spring-boot 不推薦JSP,想使用JSP需要配置application.properties。

添加src/main/resources/application.properties内容:

# 頁面預設字首目錄
spring.mvc.view.prefix=/WEB-INF/jsp/
# 響應頁面預設字尾
spring.mvc.view.suffix=.jsp
# 自定義屬性,可以在Controller中讀取
application.hello=Hello Shanhy           

在 src/main 下面建立 webapp/WEB-INF/jsp 目錄用來存放我們的jsp頁面。

index.jsp

<%@ page language="java" pageEncoding="UTF-8"%>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Spring Boot Sample</title>
</head>

<body>
    Time: ${time}
    <br>
    Message: ${message}
</body>
</html>           

page1.jsp

<%@ page language="java" pageEncoding="UTF-8"%>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Spring Boot Sample</title>
</head>

<body>
    <h1>${content }</h1>
</body>
</html>           

要想讓spring-boot支援JSP,需要将項目打成war包。

我們做最後一點修改,修改pom.xml檔案,将 jar 中的 jar 修改為 war

然後啟動spring-boot服務。

通路頁面檢視結果:

http://localhost:8080 http://localhost:8080/page1 http://localhost:8080/page2

最後附上工程結構:

如果需要使用 FreeMarker 的同學,請按下面的方法說明修改:

1、去掉 application.properties 中的 spring.mvc.view.prefix 和 spring.mvc.view.suffix 配置。

2、将 .ftl 模版頁面放到 resources/templates 中(如上面工程截圖所示)

其中 error.ftl 是系統預設的錯誤頁,内容自定。

3、修改 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>org.springboot.sample</groupId>
    <artifactId>spring-boot-sample</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>
<!--    <packaging>war</packaging> -->

    <name>spring-boot-sample</name>
    <description>Spring Boot Sample Web Application</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.3.1.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>

<!--        <dependency> -->
<!--            <groupId>org.springframework.boot</groupId> -->
<!--            <artifactId>spring-boot-starter-web</artifactId> -->
<!--        </dependency> -->
<!--        <dependency> -->
<!--            <groupId>org.springframework.boot</groupId> -->
<!--            <artifactId>spring-boot-starter-tomcat</artifactId> -->
<!--        </dependency> -->
<!--        <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-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-freemarker</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>


</project>