Spring Boot JSP 示例

叁歲伎倆 2023-10-01 16:38 25阅读 0赞

[Spring Boot JSP Tutorial with Example][]

本教程将引导您完成使用 Spring Boot 和 JSP 创建 Hello World Web 应用程序示例的步骤

JSP 代表 Jakarta Server Pages（又名 JavaServer Pages）。它是一个服务器端模板引擎，帮助创建动态 HTML 网页

### 您将构建什么 ###

![b24561ff9152165514122176e87c0321.gif][]

### 你需要什么 ###

*  JDK 8+ 或 OpenJDK 8+
 *  Maven 3+
 *  你最喜欢的 IDE

### 项目结构 ###

以下是我们将创建的所有文件的最终项目结构

├── src
    │   └── main
    │       ├── java
    │       │   └── com
    │       │       └── hellokoding
    │       │           └── springboot
    │       │               └── view
    │       │                   ├── Application.java
    │       │                   └── HelloController.java
    │       ├── resources
    │       │   ├── static
    │       │   │   ├── css
    │       │   │   │   └── main.css
    │       │   │   └── js
    │       │   │       └── main.js
    │       │   └── application.properties
    │       └── webapp
    │           └── WEB-INF
    │               └── jsp
    │                   └── hello.jsp
    └── pom.xml

`pom.xml`是Maven用来管理项目依赖和构建过程的配置文件，通常放在项目根目录下

Web 控制器类用于将用户请求映射到 JSP 文件，将在 src/main/java 中创建

JSP 视图模板文件将在 src/main/webapp/WEB-INF/jsp 中创建

CSS 和 JavaScript 文件将在 src/main/resources/static 中创建

application.properties 是 Spring Boot 使用的配置文件，将在 src/main/resources 中创建

Application.java 是 Spring Boot 启动应用程序的启动文件，将在 src/main/java 中创建

### 初始化一个新的 Spring Boot 应用程序 ###

除了使用 IDE 之外，我们还可以通过 Web UI 或命令行工具（如 cURL、HTTPie 或 Spring Boot CLI）使用 Spring Initializr 创建和初始化新的 Spring Boot 项目。[在此处][Link 1]了解有关使用这些工具的更多信息

首先，我们将选择 Web 和 Devtools 作为依赖项。下面是一个 cURL 的例子

curl https://start.spring.io/starter.zip \  
        -d dependencies=web,devtools \
        -d javaVersion=1.8 \
        -d packageName=com.hellokoding.springboot \
        -d groupId=com.hellokoding.springboot \
        -d artifactId=hk-springboot-jsp \
        -o hk-springboot-jsp.zip

curl https://start.spring.io/starter.zip -d dependencies=web,devtools -d javaVersion=1.8 -d packageName=com.hellokoding.springboot -d groupId=com.hellokoding.springboot -d artifactId=hk-springboot-jsp -o hk-springboot-jsp.zip

解压 hk-springboot-jsp.zip 文件并将示例项目导入您的 IDE

### 项目依赖 ###

对于 Spring Boot JSP Web 应用程序，我们需要 pom.xml 文件的以下依赖项

*  `spring-boot-starter-web` 提供我们在 Spring Boot 中开发 Web 应用程序所需的所有依赖项和自动配置，包括 Tomcat 嵌入式 servlet 容器
 *  `tomcat-embed-jasper` 提供在Tomcat中编译JSP文件的支持

库版本可以省略，因为它将由 Spring Boot 提供的父 pom 解决

<dependency>  
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>  
    <dependency>  
        <groupId>org.apache.tomcat.embed</groupId>
        <artifactId>tomcat-embed-jasper</artifactId>
    </dependency>

除此之外，每当 Java 类或类路径上的静态文件发生变化时，我们还使用`spring-boot-devtools`依赖项来自动触发应用程序重新启动或在开发环境中实时重新加载。但是，要利用它，您需要将 IDE 配置为在文件被修改时自动保存和自动编译

在生产环境中，当从 jar 文件启动 Spring Boot 应用程序时，`devtools`会自动禁用

<dependency>  
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <scope>runtime</scope>
        <optional>true</optional>
    </dependency>

### 创建控制器 ###

创建 Spring Boot 控制器文件以将 HTTP 请求映射到 JSP 视图文件

`[HelloController.java]`

package com.hellokoding.springboot.view;
    
    import org.springframework.stereotype.Controller;  
    import org.springframework.ui.Model;  
    import org.springframework.web.bind.annotation.GetMapping;  
    import org.springframework.web.bind.annotation.RequestParam;
    
    @Controller
    public class HelloController {  
        @GetMapping({"/", "/hello"})
        public String hello(Model model, @RequestParam(value="name", required=false, defaultValue="World") String name) {
            model.addAttribute("name", name);
            return "hello";
        }
    }

`@Controller`注解表示被注解的类是一个 web控制器

`@GetMapping`将“/”（主页）和“/hello”的 HTTP GET 请求映射到`hello`方法

`@RequestParam`将方法参数绑定`name`到请求查询字符串参数

`Model` 是一个 Spring 对象，用于在处理程序和视图模板之间共享数据

视图模板名称由`return`处理程序的语句和文件`spring.mvc.view.suffix`中定义的配置属性定义`application.properties`。所以在这个`hello`处理方法中，返回视图是`hello.jsp`

### JSP 视图模板文件 ###

创建一个简单的 JSP 视图模板文件以向用户显示动态消息

`[hello.jsp]`

<!DOCTYPE html>  
    <html lang="en">  
    <head>  
        <meta charset="UTF-8">
        <title>Hello ${name}!</title>
        <link href="/css/main.css" rel="stylesheet">
    </head>  
    <body>  
        <h2 class="hello-title">Hello ${name}!</h2>
        <script src="/js/main.js"></script>
    </body>  
    </html>

动态消息是`${name}`。它是一种[Java 表达式语言][Java]，使 JSP 文件能够访问模型中的数据。它的值由`model.addAttribute("name", name);`上面HelloController中定义的填充

### 静态文件 ###

在 /src/main/resources/static 中创建 2 个简单的 CSS 和 JavaScript 文件

该`main.css`文件通过以下方式链接到 JSP 视图中`<link href="/css/main.css" rel="stylesheet">`

`[main.css]`

.hello-title{
        color: darkgreen;
    }

该`main.js`文件通过以下方式包含在 JSP 视图中`<script src="/js/main.js"></script>`

`[main.js]`

(function(){
        console.log("Hello World!");
    })();

### 应用程序配置 ###

在内部创建`application.properties`文件`src/main/resources`以通过`spring.mvc.view`属性配置 Spring MVC 视图解析器

`[application.properties]`

spring.mvc.view.prefix: /WEB-INF/jsp/
    spring.mvc.view.suffix: .jsp

该`spring.mvc.view.prefix`属性定义了 JSP 文件的路径，该`spring.mvc.view.suffix`属性定义了我们想要使用的文件扩展名

`org.springframework.boot.autoconfigure.web.servlet`在后台，Spring Boot 将根据上述设置通过使用包内 WebMvcAutoConfiguration 的以下方法自动配置 Spring MVC 视图解析器

`[WebMvcAutoConfiguration.java]`

@Bean
    @ConditionalOnMissingBean
    public InternalResourceViewResolver defaultViewResolver() {  
        InternalResourceViewResolver resolver = new InternalResourceViewResolver();
        resolver.setPrefix(this.mvcProperties.getView().getPrefix());
        resolver.setSuffix(this.mvcProperties.getView().getSuffix());
        return resolver;
    }

### 运行和测试 ###

创建一个 Application 类并使用 @SpringBootApplication 注解来启动应用程序

`[Application.java]`

package com.hellokoding.springboot.view;
    
    import org.springframework.boot.SpringApplication;  
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    public class Application {  
        public static void main(String[] args) {
            SpringApplication.run(Application.class, args);
        }
    }

通过在项目根目录的终端控制台上键入以下命令来运行应用程序

./mvnw clean spring-boot:run

您将在控制台中看到此文本

o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''

在您的网络浏览器上访问`http://localhost:8080`，预计会出现以下响应

Hello, World!

尝试修改 JSP、CSS 和 JavaScript 文件，并刷新浏览器，HTML 响应将相应更新，感谢来自 `spring-boot-devtools`

在生产环境中，您可能希望将 Spring Boot 应用程序打包并作为单个 jar 文件运行

修改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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.6.3</version>
            <relativePath/> 
        </parent>
        <groupId>com.hellokoding.springboot</groupId>
        <artifactId>hk-springboot-jsp</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>demo</name>
        <description>Demo project for Spring Boot</description>
        <properties>
            <java.version>1.8</java.version>
        </properties>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.apache.tomcat.embed</groupId>
                <artifactId>tomcat-embed-jasper</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-devtools</artifactId>
                <scope>runtime</scope>
                <optional>true</optional>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>
    
        <build>
            <resources>
                <resource>
                    
                    <directory>${basedir}/src/main/webapp</directory>
                    
                    <targetPath>META-INF/resources</targetPath>
                    <includes>
                        <include>**/**</include>
                    </includes>
                </resource>
                <resource>
                    <directory>${basedir}/src/main/resources</directory>
                </resource>
            </resources>
    
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <version>1.4.2.RELEASE</version>
                </plugin>
            </plugins>
        </build>
    
    </project>

./mvnw clean package
    java -jar target/hk-springboot-jsp-0.0.1-SNAPSHOT.jar

### 结论 ###

在本教程中，我们学习了使用 JSP 在 Spring Boot 中创建一个 Hello World Web 应用程序。源代码在[Github上可用][Github]

[Spring Boot JSP Tutorial with Example]: https://hellokoding.com/spring-boot-hello-world-example-with-jsp/
[b24561ff9152165514122176e87c0321.gif]: https://img-blog.csdnimg.cn/img_convert/b24561ff9152165514122176e87c0321.gif
[Link 1]: https://hellokoding.com/create-a-new-spring-boot-project/
[Java]: https://docs.oracle.com/javaee/6/tutorial/doc/gjddd.html
[Github]: https://github.com/hellokoding/hellokoding-courses/tree/master/springboot-examples/springboot-jsp-helloworld