【SpringBoot2.x】-SpringBoot Web开发中Thymeleaf、Web、Tomcat以及Favicon

简介: Web开发是开发中至关重要的一部分, Web开发的核心内容主要包括内嵌Servlet容器和Spring MVC。更重要的是,Spring Boot``为web开发提供了快捷便利的方式进行开发,使用依赖jar:spring-boot-starter-web,提供了嵌入式服务器Tomcat以及Spring MVC的依赖,且自动配置web相关配置,可查看org.springframework.boot.autoconfigure.web。

github:github.com/Ccww-lx/Spr…


模块:spring-boot-starter-base-web


Web开发是开发中至关重要的一部分, Web开发的核心内容主要包括内嵌Servlet容器和Spring MVC。更重要的是,Spring Boot``为web开发提供了快捷便利的方式进行开发,使用依赖jar:spring-boot-starter-web,提供了嵌入式服务器Tomcat以及Spring MVC的依赖,且自动配置web相关配置,可查看org.springframework.boot.autoconfigure.web


Web相关的核心功能:


  • Thymeleaf模板引擎
  • Web相关配置
  • Tomcat配置
  • Favicon配置


1.模板配置


1.1原理以及源码分析


Spring Boot提供了大量模板引擎, 包含括FreeMarkerGroovyThymeleafVelocity和MustacheSpring Boot中推荐 使用Thymeleaf作为模板引擎, 因为Thymeleaf提供了完美的Spring MVC的支持。


Spring Bootorg.springframework.boot.autoconfigure.thymeleaf包下实现自动配置,如下所示:


0.png


ThymeleafAutoConfiguration源码:


@Configuration
@EnableConfigurationProperties(ThymeleafProperties.class)
@ConditionalOnClass({ TemplateMode.class, SpringTemplateEngine.class })
@AutoConfigureAfter({ WebMvcAutoConfiguration.class, WebFluxAutoConfiguration.class })
public class ThymeleafAutoConfiguration {
        //配置TemplateResolver
  @Configuration
  @ConditionalOnMissingBean(name = "defaultTemplateResolver")
  static class DefaultTemplateResolverConfiguration {
            ...
  }
        //配置TemplateEngine
  @Configuration
  protected static class ThymeleafDefaultConfiguration {
            ...
  }
        //配置SpringWebFluxTemplateEngine
  @Configuration
  @ConditionalOnWebApplication(type = Type.SERVLET)
  @ConditionalOnProperty(name = "spring.thymeleaf.enabled", matchIfMissing = true)
  static class ThymeleafWebMvcConfiguration {
         ...
  }
        //配置thymeleafViewResolver
  @Configuration
  @ConditionalOnWebApplication(type = Type.REACTIVE)
  @ConditionalOnProperty(name = "spring.thymeleaf.enabled", matchIfMissing = true)
  static class ThymeleafWebFluxConfiguration {
           ...
  }
    ...
}
复制代码


ThymeleafAutoConfiguration自动加载Web所需的TemplateResolverTemplateEngineSpringWebFluxTemplateEngine以及thymeleafViewResolver,并通过ThymeleafProperties进行Thymeleaf属性配置。详细细节查看官方源码。


ThymeleafProperties源码:


//读取application.properties配置文件的属性
@ConfigurationProperties(prefix = "spring.thymeleaf")
public class ThymeleafProperties {
  private static final Charset DEFAULT_ENCODING = StandardCharsets.UTF_8;
  public static final String DEFAULT_PREFIX = "classpath:/templates/";
  public static final String DEFAULT_SUFFIX = ".html";
  /**
   *Web模板文件前缀路径属性,Spring boot默认路径为classpath:/templates/
   */
  private String prefix = DEFAULT_PREFIX;
  /**
   * Web模板文件后缀属性,默认为html
   */
  private String suffix = DEFAULT_SUFFIX;
  /**
   * Web模板模式属性,默认为HTML
   */
  private String mode = "HTML";
  /**
   *  Web模板文件编码属性,默认为UTF_8
   */
  private Charset encoding = DEFAULT_ENCODING;
        ....
}
复制代码


可以从ThymeleafProperties中看出,Thymeleaf的默认设置,以及可以通过前缀为spring.thymeleaf属性修改Thymeleaf默认配置。


1.2 示例


1).根据默认Thymeleaf配置,在src/main/resources/下,创建static文件夹存放脚本样式静态文件以及templates文件夹存放后缀为html的页面,如下所示:


1.png


2)index.html页面


<!DOCTYPE html>
<!-- 导入xmlns: th=http://www.thymeleaf.org命名空间 -->
<html xmlns:th="http://www.thymeleaf.org">
<html lang="en">
 <head>
     <meta charset="UTF-8">
    <title>首面详细</title>
 </head>
  <body>
    <div class="user" align="center"  width="400px" height="400px">
        message:<span th:text="${user.message}"/><br/>
       用户名:<span th:text="${user.username}"/><br/>
         密码:<span th:text="${user.password}"/>
    </div>
 </body>
</html>
复制代码


3).controller配置:


@Controller
public class LoginController {
    @Autowired
    private LoginService loginService;
    /**
     * 将首页设置为登陆页面login.html
     * @return
     */
    @RequestMapping("/")
    public String startIndex() {
        return "login";
    }
    /**
     *  登陆验证
     * @param username
     * @param password
     * @param model
     * @return
     */
    @RequestMapping("/login")
    public String login(@RequestParam("username") String username, @RequestParam("password") String password, Model model) {
        UserDTO userDTO = loginService.login(username, password);
        model.addAttribute("user", userDTO);
        return "index";
    }
}
复制代码


2. web相关配置


根据WebMvcAutoConfiguration以及WebMvcProperties理解Spring Boot提供的自动配置原理。


2.1 ViewResolver以及静态资源


Spring boot自动配置ViewResolver


  • ContentNegotiatingViewResolver(最高优先级Ordered.HIGHEST_PRECEDENCE
  • BeanNameViewResolver
  • InternalResourceViewResolver


静态资源


addResourceHandlers 方法默认定义了/static/public/resources/METAINF/resources文件夹下的静态文件直接映射为/**


2.2 Formatter和Converter类型转换器


addFormatters 方法会自动加载ConverterGenericConverter以及Formatter的实现类、并注册到Spring MVC中,因此自定义类型转换器只需继承其三个接口即可。


自定义Formatter:


/**
 * 将格式为 ccww:ccww88转为UserDTO
 *
 * @Auther: ccww
 * @Date: 2019/10/4 16:25
 * @Description:
 */
public class StringToUserConverter implements Converter<String, UserDTO> {
    @Nullable
    public UserDTO convert(String s) {
        UserDTO userDTO = new UserDTO();
        if (StringUtils.isEmpty(s))
            return userDTO;
        String[] item = s.split(":");
        userDTO.setUsername(item[0]);
        userDTO.setPassword(item[1]);
        return userDTO;
    }
}
复制代码


2.3 HttpMessageConverters (HTTP request (请求)和response (响应)的转换器)


configureMessageConverters方法自动配置HttpMessageConverters:


public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
      this.messageConvertersProvider.ifAvailable((customConverters) -> converters
          .addAll(customConverters.getConverters()));
    }
复制代码


通过加载由HttpMessageConvertersAutoConfiguration定义的HttpMessageConverters,会自动注册一系列HttpMessage Converter类,比如Spring MVC默认:


  • ByteArrayHttpMessageConverter
  • StringHttpMessageConverter
  • ResourceHttpMessageConverter
  • SourceHttpMessageConverter
  • AllEncompassingFormHttpMessageConverter


自定义HttpMessageConverters,只需要在自定义的HttpMessageConvertersBean注册自定义HttpMessageConverter即可。 如下:


注册自定义的HttpMessageConverter


@Configuration
public class CustomHttpMessageConverterConfig {
    @Bean
    public HttpMessageConverters converter(){
        HttpMessageConverter<?> userJsonHttpMessageConverter=new UserJsonHttpMessageConverter();
        return new HttpMessageConverters(userJsonHttpMessageConverter);
    }
}
复制代码


自定义HttpMessageConverter


public class UserJsonHttpMessageConverter extends AbstractHttpMessageConverter<UserDTO> {
    private static Charset DEFUALT_ENCODE=Charset.forName("UTF-8");
    public UserJsonHttpMessageConverter(){
        super(new MediaType("application", "xxx-ccww", DEFUALT_ENCODE));
    }
    protected boolean supports(Class aClass) {
            return UserDTO.class == aClass;
    }
    protected UserDTO readInternal(Class aClass, HttpInputMessage httpInputMessage) throws IOException, HttpMessageNotReadableException {
        String message = StreamUtils.copyToString(httpInputMessage.getBody(), DEFUALT_ENCODE);
        String[] messages = message.split("-");
        UserDTO userDTO = new UserDTO();
        userDTO.setUsername(messages[0]);
        userDTO.setMessage(messages[1]);
        return userDTO;
    }
    protected void writeInternal(UserDTO userDTO, HttpOutputMessage httpOutputMessage) throws IOException, HttpMessageNotWritableException {
        String out = "ccww: " + userDTO.getUsername() + "-" + userDTO.getMessage();
        httpOutputMessage.getBody().write(out.getBytes());
    }
}
复制代码


同理,可以将Servlet、Filter以及Listener相对于的注册即可。


2.4 MVC相关配置


自定义的MVC配置类上加@EnableWebMvc将废弃到Spring boot默认配置,完全由自己去控制MVC配置,但通常是Springboot默认配置+所需的额外MVC配置,只需要配置类继承WebMvcConfigurerAdapter即可


2.5 Tomcat配置


可以使用两种方式进行Tomcat配置属性


  1. application.properties配置属性即可,Tomcat是以"server.tomcat"为前缀的特有配置属性,通用的是以"server"作为前缀;
  2. 通过实现WebServerFactoryCustomizer接口自定义属性配置类即可,同理其他服务器实现对应的接口即可。


application.properties配置属性:


#通用Servlet容器配置
server.port=8888
#tomcat容器配置
#配置Tomcat编码, 默认为UTF-8
server.tomcat.uri-encoding = UTF-8
# Tomcat是否开启压缩, 默认为关闭off
server.tomcat.compression=off
复制代码


实现WebServerFactoryCustomizer接口自定义:


/**
 * 配置tomcat属性
 * @Auther: ccww
 * @Date: 2019/10/5 23:22
 * @Description: 
 */
@Component
public class CustomTomcatServletContainer implements WebServerFactoryCustomizer<ConfigurableServletWebServerFactory> {
    public void customize(ConfigurableServletWebServerFactory configurableServletWebServerFactory) {
        ((TomcatServletWebServerFactory)configurableServletWebServerFactory).addConnectorCustomizers(new TomcatConnectorCustomizer() {
            public void customize(Connector connector) {
                Http11NioProtocol protocol = (Http11NioProtocol) connector.getProtocolHandler();
                protocol.setMaxConnections(200);
                protocol.setMaxThreads(200);
                protocol.setSelectorTimeout(3000);
                protocol.setSessionTimeout(3000);
                protocol.setConnectionTimeout(3000);
                protocol.setPort(8888);
            }
        });
    }
}
复制代码


替换spring boot 默认Servlet容器tomcat,直接在依赖中排除,并导入相应的Servlet容器依赖:


<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starterweb</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-startertomcat</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starterjetty</artifactId>
</dependency
复制代码


2.6 自定义Favicon


自定义Favicon只需要则只需将自己的favicon.ico( 文件名不能变动) 文件放置在类路径根目录、 类路径META-INF/resources/下、 类路径resources/下、 类路径static/下或类路径public/下。


> 各位看官还可以吗?喜欢的话,动动手指点个💗,点个关注呗!!谢谢支持! >


目录
相关文章
|
5月前
|
缓存 Java 应用服务中间件
Spring Boot配置优化:Tomcat+数据库+缓存+日志,全场景教程
本文详解Spring Boot十大核心配置优化技巧,涵盖Tomcat连接池、数据库连接池、Jackson时区、日志管理、缓存策略、异步线程池等关键配置,结合代码示例与通俗解释,助你轻松掌握高并发场景下的性能调优方法,适用于实际项目落地。
921 5
|
监控 Java 应用服务中间件
Spring Boot整合Tomcat底层源码分析
【11月更文挑战第20天】Spring Boot是一个用于快速构建基于Spring框架的应用程序的开源框架。它通过自动配置和起步依赖等特性,大大简化了Spring应用的开发和部署过程。本文将深入探讨Spring Boot的背景历史、业务场景、功能点以及底层原理,并通过Java代码手写模拟Spring Boot的启动过程,特别是其与Tomcat的整合。
381 1
|
8月前
|
开发框架 JSON 中间件
Go语言Web开发框架实践:使用 Gin 快速构建 Web 服务
Gin 是一个高效、轻量级的 Go 语言 Web 框架,支持中间件机制,非常适合开发 RESTful API。本文从安装到进阶技巧全面解析 Gin 的使用:快速入门示例(Hello Gin)、定义 RESTful 用户服务(增删改查接口实现),以及推荐实践如参数校验、中间件和路由分组等。通过对比标准库 `net/http`,Gin 提供更简洁灵活的开发体验。此外,还推荐了 GORM、Viper、Zap 等配合使用的工具库,助力高效开发。
|
Java 关系型数据库 MySQL
"解锁Java Web传奇之旅:从JDK1.8到Tomcat,再到MariaDB,一场跨越数据库的冒险安装盛宴,挑战你的技术极限!"
【8月更文挑战第19天】在Linux上搭建Java Web应用环境,需安装JDK 1.8、Tomcat及MariaDB。本指南详述了使用apt-get安装OpenJDK 1.8的方法,并验证其版本。接着下载与解压Tomcat至`/usr/local/`目录,并启动服务。最后,通过apt-get安装MariaDB,设置基本安全配置。完成这些步骤后,即可验证各组件的状态,为部署Java Web应用打下基础。
294 1
|
Java 应用服务中间件 Shell
Nginx+Keepalived+Tomcat 实现Web高可用集群
Nginx+Keepalived+Tomcat 实现Web高可用集群
433 0
|
监控 前端开发 Java
SpringBoot集成Tomcat、DispatcherServlet
通过这些配置,您可以充分利用 Spring Boot 内置的功能,快速构建和优化您的 Web 应用。
1009 21
|
安全 数据库 开发者
揭秘!Python Web开发新宠儿Web2py,轻松打造博客竟有如此奥秘?一探究竟!
【8月更文挑战第31天】Web2py是一款全功能的Python Web应用框架,以其简洁、高效和全面的特点脱颖而出。它集成了数据库抽象层、表单处理、模板引擎等模块,使Web开发变得更简单、快速和安全。本文通过构建一个简单的博客应用,详细介绍了Web2py的安装、配置及实际应用,展示了其强大的功能和直观的代码结构,适合希望提高开发效率的开发者。
271 1
|
开发框架 中间件 API
揭秘!Tornado技术如何颠覆传统,解锁Web开发速度极限?你的高效Web应用就差这一步!
【8月更文挑战第31天】Tornado 是 Python 生态中的一款高性能 Web 开发框架,以其非阻塞 I/O 模型和高并发处理能力著称。它采用协程和异步 I/O 实现了高效的并行处理,使服务器能同时处理大量连接。
162 1
|
Java 应用服务中间件 Apache
浅谈Tomcat和其他WEB容器的区别
Tomcat是一款轻量级的免费开源Web应用服务器,常用于中小型系统及并发访问量适中的场景,尤其适合开发和调试JSP程序。它不仅能处理HTML页面,还充当Servlet和JSP容器。相比之下,物理服务器是指具备处理器、硬盘等硬件设施的服务器,如云服务器,其设计目标是在处理能力、稳定性和安全性等方面提供高标准服务。简言之,Tomcat专注于运行Java应用,而物理服务器则提供基础计算资源。
|
jenkins 持续交付 开发工具
"引爆效率革命!Docker+Jenkins+GIT+Tomcat:解锁持续集成魔法,一键部署Java Web应用的梦幻之旅!"
【8月更文挑战第9天】随着软件开发复杂度的增加,自动化变得至关重要。本文通过实例展示如何结合Docker、Jenkins、Git与Tomcat建立高效的持续集成(CI)流程。Docker确保应用环境一致性;Jenkins自动化处理构建、测试和部署;Git管理源代码版本;Tomcat部署Web应用。在Jenkins中配置Git插件并设置项目,集成Docker构建Tomcat应用镜像并运行容器。此外,通过自动化测试、代码质量检查、环境隔离和日志监控确保CI流程顺畅,从而显著提高开发效率和软件质量。
261 3