1. PingCode智库首页
  2. 百科

Springboot如何访问静态html

Edit1 • • 百科

Springboot如何访问静态html

Spring Boot访问静态HTML的方式包括：将HTML文件放在src/main/resources/static目录中、配置静态资源路径、使用@Controller注解返回视图名。其中，将HTML文件放在src/main/resources/static目录中是最简单和常用的方法。下面将详细展开介绍这种方法，以及其他两种方法的实现步骤和注意事项。

一、将HTML文件放在src/main/resources/static目录中

1.1 简介

Spring Boot 默认会将位于 src/main/resources/static 目录中的静态资源（如 HTML 文件、CSS、JavaScript、图片等）自动映射到 / 路径下。这意味着你只需将 HTML 文件放在这个目录中即可通过浏览器访问。

1.2 实现步骤

  1. 创建一个 Spring Boot 项目。
  2. 在 src/main/resources 目录下创建一个名为 static 的文件夹。
  3. 将你的 HTML 文件放在 static 文件夹中，例如 index.html。
  4. 启动 Spring Boot 应用。
  5. 在浏览器中访问 http://localhost:8080/index.html。

1.3 示例

假设你有一个名为 index.html 的文件，其内容如下：

<!DOCTYPE html>


<html lang="en">


<head>


    <meta charset="UTF-8">


    <title>Static HTML Example</title>


</head>


<body>


    <h1>Hello, Spring Boot!</h1>


</body>


</html>

将这个文件放在 src/main/resources/static 目录中，启动应用后，在浏览器中访问 http://localhost:8080/index.html，你将看到页面显示“Hello, Spring Boot!”。

二、配置静态资源路径

2.1 简介

有时候你可能希望将静态资源放在不同的目录中，此时可以通过配置来实现这一点。Spring Boot 提供了多种配置静态资源路径的方法。

2.2 实现步骤

  1. 在 application.properties 文件中配置静态资源路径。例如：

spring.resources.static-locations=classpath:/my-static/

  1. 创建一个名为 my-static 的文件夹，并将其放在 src/main/resources 目录中。
  2. 将你的 HTML 文件放在 my-static 文件夹中。
  3. 启动 Spring Boot 应用。
  4. 在浏览器中访问 http://localhost:8080/index.html。

2.3 示例

假设你有一个名为 index.html 的文件，其内容如下：

<!DOCTYPE html>


<html lang="en">


<head>


    <meta charset="UTF-8">


    <title>Static HTML Example</title>


</head>


<body>


    <h1>Hello, Spring Boot with Custom Path!</h1>


</body>


</html>

将这个文件放在 src/main/resources/my-static 目录中，启动应用后，在浏览器中访问 http://localhost:8080/index.html，你将看到页面显示“Hello, Spring Boot with Custom Path!”。

三、使用@Controller注解返回视图名

3.1 简介

如果你需要在控制器中处理一些逻辑，然后返回一个静态 HTML 页面，可以使用 @Controller 注解和 ViewResolver。

3.2 实现步骤

  1. 创建一个 Spring Boot 项目。
  2. 在 src/main/resources 目录下创建一个名为 templates 的文件夹（默认情况下，Spring Boot 使用 Thymeleaf 模板引擎）。
  3. 将你的 HTML 文件放在 templates 文件夹中。
  4. 创建一个控制器类，并使用 @Controller 注解。
  5. 在控制器方法中返回视图名。

3.3 示例

假设你有一个名为 index.html 的文件，其内容如下：

<!DOCTYPE html>


<html lang="en">


<head>


    <meta charset="UTF-8">


    <title>Static HTML Example</title>


</head>


<body>


    <h1>Hello, Spring Boot with Controller!</h1>


</body>


</html>

将这个文件放在 src/main/resources/templates 目录中，然后创建一个控制器类：

import org.springframework.stereotype.Controller;


import org.springframework.web.bind.annotation.GetMapping;


@Controller


public class MyController {


    @GetMapping("/index")


    public String index() {


        return "index";


    }


}

启动应用后，在浏览器中访问 http://localhost:8080/index，你将看到页面显示“Hello, Spring Boot with Controller!”。

四、使用Thymeleaf模板引擎

4.1 简介

Thymeleaf 是一个现代的服务器端 Java 模板引擎，用于 Web 和独立环境中的 Java 应用程序。Spring Boot 默认集成了 Thymeleaf，因此你可以非常方便地使用它来渲染动态 HTML 页面。

4.2 实现步骤

  1. 在 pom.xml 文件中添加 Thymeleaf 依赖：

<dependency>


    <groupId>org.springframework.boot</groupId>


    <artifactId>spring-boot-starter-thymeleaf</artifactId>


</dependency>

  1. 在 src/main/resources/templates 目录中创建一个 HTML 文件，例如 index.html。
  2. 在控制器类中返回视图名。
  3. 启动 Spring Boot 应用。
  4. 在浏览器中访问相应的 URL。

4.3 示例

假设你有一个名为 index.html 的文件，其内容如下：

<!DOCTYPE html>


<html lang="en">


<head>


    <meta charset="UTF-8">


    <title>Thymeleaf Example</title>


</head>


<body>


    <h1>Hello, Thymeleaf!</h1>


</body>


</html>

将这个文件放在 src/main/resources/templates 目录中，然后创建一个控制器类：

import org.springframework.stereotype.Controller;


import org.springframework.web.bind.annotation.GetMapping;


@Controller


public class MyController {


    @GetMapping("/index")


    public String index() {


        return "index";


    }


}

启动应用后，在浏览器中访问 http://localhost:8080/index，你将看到页面显示“Hello, Thymeleaf!”。

五、配置自定义ViewResolver

5.1 简介

如果你需要自定义视图解析器，可以通过配置 ViewResolver 来实现。例如，你可以配置一个 InternalResourceViewResolver 来解析 JSP 文件。

5.2 实现步骤

  1. 在 pom.xml 文件中添加相关依赖，例如 JSP 依赖：

<dependency>


    <groupId>org.apache.tomcat.embed</groupId>


    <artifactId>tomcat-embed-jasper</artifactId>


</dependency>


<dependency>


    <groupId>javax.servlet</groupId>


    <artifactId>javax.servlet-api</artifactId>


    <scope>provided</scope>


</dependency>

  1. 在配置类中配置 ViewResolver。
  2. 将你的 JSP 文件放在 src/main/webapp/WEB-INF/jsp 目录中。
  3. 在控制器类中返回视图名。
  4. 启动 Spring Boot 应用。

5.3 示例

假设你有一个名为 index.jsp 的文件，其内容如下：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>


<html>


<head>


    <title>JSP Example</title>


</head>


<body>


    <h1>Hello, JSP!</h1>


</body>


</html>

将这个文件放在 src/main/webapp/WEB-INF/jsp 目录中，然后创建一个配置类：

import org.springframework.context.annotation.Bean;


import org.springframework.context.annotation.Configuration;


import org.springframework.web.servlet.view.InternalResourceViewResolver;


@Configuration


public class WebConfig {


    @Bean


    public InternalResourceViewResolver viewResolver() {


        InternalResourceViewResolver resolver = new InternalResourceViewResolver();


        resolver.setPrefix("/WEB-INF/jsp/");


        resolver.setSuffix(".jsp");


        return resolver;


    }


}

创建一个控制器类：

import org.springframework.stereotype.Controller;


import org.springframework.web.bind.annotation.GetMapping;


@Controller


public class MyController {


    @GetMapping("/index")


    public String index() {


        return "index";


    }


}

启动应用后，在浏览器中访问 http://localhost:8080/index，你将看到页面显示“Hello, JSP!”。

六、使用FreeMarker模板引擎

6.1 简介

FreeMarker 是一个基于模板的通用页面生成工具，主要用于生成 HTML Web 页面。Spring Boot 也集成了 FreeMarker，你可以方便地使用它来渲染动态 HTML 页面。

6.2 实现步骤

  1. 在 pom.xml 文件中添加 FreeMarker 依赖：

<dependency>


    <groupId>org.springframework.boot</groupId>


    <artifactId>spring-boot-starter-freemarker</artifactId>


</dependency>

  1. 在 src/main/resources/templates 目录中创建一个 FreeMarker 模板文件，例如 index.ftl。
  2. 在控制器类中返回视图名。
  3. 启动 Spring Boot 应用。
  4. 在浏览器中访问相应的 URL。

6.3 示例

假设你有一个名为 index.ftl 的文件，其内容如下：

<!DOCTYPE html>


<html lang="en">


<head>


    <meta charset="UTF-8">


    <title>FreeMarker Example</title>


</head>


<body>


    <h1>Hello, FreeMarker!</h1>


</body>


</html>

将这个文件放在 src/main/resources/templates 目录中，然后创建一个控制器类：

import org.springframework.stereotype.Controller;


import org.springframework.web.bind.annotation.GetMapping;


@Controller


public class MyController {


    @GetMapping("/index")


    public String index() {


        return "index";


    }


}

启动应用后，在浏览器中访问 http://localhost:8080/index，你将看到页面显示“Hello, FreeMarker!”。

七、使用Groovy模板引擎

7.1 简介

Groovy 模板是一种基于 Groovy 语言的模板引擎，Spring Boot 也集成了它，可以用于生成动态 HTML 页面。

7.2 实现步骤

  1. 在 pom.xml 文件中添加 Groovy 模板依赖：

<dependency>


    <groupId>org.springframework.boot</groupId>


    <artifactId>spring-boot-starter-groovy-templates</artifactId>


</dependency>

  1. 在 src/main/resources/templates 目录中创建一个 Groovy 模板文件，例如 index.tpl。
  2. 在控制器类中返回视图名。
  3. 启动 Spring Boot 应用。
  4. 在浏览器中访问相应的 URL。

7.3 示例

假设你有一个名为 index.tpl 的文件，其内容如下：

<!DOCTYPE html>


<html lang="en">


<head>


    <meta charset="UTF-8">


    <title>Groovy Template Example</title>


</head>


<body>


    <h1>Hello, Groovy Template!</h1>


</body>


</html>

将这个文件放在 src/main/resources/templates 目录中，然后创建一个控制器类：

import org.springframework.stereotype.Controller;


import org.springframework.web.bind.annotation.GetMapping;


@Controller


public class MyController {


    @GetMapping("/index")


    public String index() {


        return "index";


    }


}

启动应用后，在浏览器中访问 http://localhost:8080/index，你将看到页面显示“Hello, Groovy Template!”。

八、使用JSP

8.1 简介

尽管 JSP 不再是创建新的 Spring Boot 应用的推荐方法，但它仍然被广泛使用。通过适当的配置，你仍然可以在 Spring Boot 中使用 JSP 视图。

8.2 实现步骤

  1. 在 pom.xml 文件中添加 JSP 相关依赖：

<dependency>


    <groupId>org.apache.tomcat.embed</groupId>


    <artifactId>tomcat-embed-jasper</artifactId>


</dependency>


<dependency>


    <groupId>javax.servlet</groupId>


    <artifactId>javax.servlet-api</artifactId>


    <scope>provided</scope>


</dependency>

  1. 创建一个名为 src/main/webapp/WEB-INF/jsp 的文件夹，并将 JSP 文件放在其中。
  2. 配置 ViewResolver。
  3. 创建一个控制器类。
  4. 启动 Spring Boot 应用。

8.3 示例

假设你有一个名为 index.jsp 的文件，其内容如下：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>


<html>


<head>


    <title>JSP Example</title>


</head>


<body>


    <h1>Hello, JSP!</h1>


</body>


</html>

将这个文件放在 src/main/webapp/WEB-INF/jsp 目录中，然后创建一个配置类：

import org.springframework.context.annotation.Bean;


import org.springframework.context.annotation.Configuration;


import org.springframework.web.servlet.view.InternalResourceViewResolver;


@Configuration


public class WebConfig {


    @Bean


    public InternalResourceViewResolver viewResolver() {


        InternalResourceViewResolver resolver = new InternalResourceViewResolver();


        resolver.setPrefix("/WEB-INF/jsp/");


        resolver.setSuffix(".jsp");


        return resolver;


    }


}

创建一个控制器类：

import org.springframework.stereotype.Controller;


import org.springframework.web.bind.annotation.GetMapping;


@Controller


public class MyController {


    @GetMapping("/index")


    public String index() {


        return "index";


    }


}

启动应用后，在浏览器中访问 http://localhost:8080/index，你将看到页面显示“Hello, JSP!”。

总结，Spring Boot 提供了多种方式来访问静态 HTML 文件和动态模板文件，每种方式都有其适用的场景。根据具体需求选择合适的方法，可以提高开发效率和应用的可维护性。

相关问答FAQs：

1. 如何在Spring Boot中访问静态HTML文件？

在Spring Boot中，可以通过将静态HTML文件放置在指定的目录中来访问它们。默认情况下，Spring Boot会将静态资源放置在src/main/resources/static目录下。只需将HTML文件放置在该目录下，然后就可以通过浏览器访问它们。

2. 如何在Spring Boot中访问其他目录下的静态HTML文件？

如果希望访问其他目录下的静态HTML文件，可以通过在application.properties文件中配置spring.resources.static-locations属性来实现。例如，如果要访问/home/user/html目录下的HTML文件，可以将以下配置添加到application.properties文件中：

spring.resources.static-locations=classpath:/static/,file:/home/user/html/

这样，Spring Boot将同时在src/main/resources/static目录和/home/user/html目录下查找静态资源。

3. 如何在Spring Boot中访问带有参数的静态HTML文件？

如果需要访问带有参数的静态HTML文件，可以使用Thymeleaf模板引擎。首先，在src/main/resources/templates目录下创建一个Thymeleaf模板，然后将参数传递给模板进行渲染。最后，将渲染后的HTML文件放置在src/main/resources/static目录下，就可以通过浏览器访问带有参数的静态HTML文件了。

文章包含AI辅助创作，作者：Edit1，如若转载，请注明出处：https://docs.pingcode.com/baike/3325056

赞 (0)
Edit1Edit1
免费注册
电话联系

4008001024

微信咨询
微信咨询
返回顶部