SpringBoot入门篇 02、SpringBoot Web开发

简介: SpringBoot入门篇 02、SpringBoot Web开发

前情回顾以及问题解决


回顾一下之前学习的内容


我们使用springboot之后就是一个个jar包,内置了一个tomcat服务器,所以我们运行jar包就能够直接运行!不用再放置到webapp下。


自动装配:springboot到底在启动时给我们配置了什么?我们能不能对其配置进行修改?是否能够进行扩展?


@xxxAutoConfiguration:向容器中自动配置组件

@xxxProperties:自动配置类,装配配置文件中自定义的一些内容

紧接着进入web开发部分需要解决的问题,版本springboot2.4.1


导入静态资源

初始运行访问是一个error页面,定制一个首页

不推荐使用jsp,使用模板引擎Thymeleaf

装配扩展SpringMVC

增删改查

拦截器

国际化


一、静态资源


SpringBoot默认为我们提供了静态资源的处理,其通过配置类WebMvcAutoConfiguration实现的。此类存放了与web开发相关的各种配置属性和方法。


我们通过下面源码的阅读即可知道静态能够放置的路径


我们定位到 WebMvcAutoConfiguration类中的WebMvcAutoConfigurationAdapter这个内部类:


// on the classpath
@SuppressWarnings("deprecation")
@Configuration(proxyBeanMethods = false)
@Import(EnableWebMvcConfiguration.class)
@EnableConfigurationProperties({ WebMvcProperties.class,
      org.springframework.boot.autoconfigure.web.ResourceProperties.class, WebProperties.class })
@Order(0)
public static class WebMvcAutoConfigurationAdapter implements WebMvcConfigurer {
  ...
    @Override
    //addResourceHandlers()方法对静态资源路径作出了默认的处理
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
    if (!this.resourceProperties.isAddMappings()) {
    logger.debug("Default resource handling disabled");
    return;
    }
    Duration cachePeriod = this.resourceProperties.getCache().getPeriod();
    CacheControl cacheControl = this.resourceProperties.getCache().getCachecontrol().toHttpCacheControl();
            //方式一:查看/webjars/**路径下是否有资源
    if (!registry.hasMappingForPattern("/webjars/**")) {
    customizeResourceHandlerRegistration(registry.addResourceHandler("/webjars/**")
      .addResourceLocations("classpath:/META-INF/resources/webjars/")
      .setCachePeriod(getSeconds(cachePeriod)).setCacheControl(cacheControl)
      .setUseLastModified(this.resourceProperties.getCache().isUseLastModified()));
    }
            //方式二:staticPathPattern="/**"
    String staticPathPattern = this.mvcProperties.getStaticPathPattern();
    if (!registry.hasMappingForPattern(staticPathPattern)) {
                //this.resourceProperties.getStaticLocations()可以得到静态资源路径
    customizeResourceHandlerRegistration(registry.addResourceHandler(staticPathPattern)
      .addResourceLocations(getResourceLocations(this.resourceProperties.getStaticLocations()))
      .setCachePeriod(getSeconds(cachePeriod)).setCacheControl(cacheControl)
      .setUseLastModified(this.resourceProperties.getCache().isUseLastModified()));
    }
  }



从源码中我们可以看到两处访问路径,那这两处访问路径都代表着什么含义呢?我们往下看


第一种:/webjars/**

我们把这一段拿下来看,可以看到/webjars/**下面添加了对应的资源路径classpath:/META-INF/resources/webjars/,简单来说就是我们在网页中访问/webjars/**就能够映射到classpath:/META-INF/resources/webjars/


if (!registry.hasMappingForPattern("/webjars/**")) {
    customizeResourceHandlerRegistration(registry.addResourceHandler("/webjars/**")
      .addResourceLocations("classpath:/META-INF/resources/webjars/")
      .setCachePeriod(getSeconds(cachePeriod)).setCacheControl(cacheControl)
      .setUseLastModified(this.resourceProperties.getCache().isUseLastModified()));
  }


接下来问题来了,classpath:/META-INF/resources/webjars/指的是我们项目中哪里?


首先我们先来了解一下webjars是什么?


WebJars是将这些通用的Web前端资源打包成Java的Jar包,然后借助Maven工具对其管理,保证这些Web资源版本唯一性,升级也比较容易。

WebJars的官网:https://www.webjars.com/

我们从官网上拿来下一段jquery的jar包依赖,放入到pom.xml中使用Maven管理:


<dependency>
    <groupId>org.webjars</groupId>
    <artifactId>jquery</artifactId>
    <version>3.5.1</version>
</dependency>


接着我们看向External Libaries中的jar包:



看上图我们就能够很清晰的看到classpath:/META-INF/resources/webjars/就是指代的第三方jar包下使用webjars打包的jar包路径。


此时我们看能否访问到该路径下的jquery.js资源,我们启动springboot来进行访问:


访问成功!这里的/webjars/映射到classpath:/META-INF/resources/webjars/里,之后添加对应的包名及资源名即可访问!!!



总结:第一种通过/webjars/**来指向对应jar包中(classpath:/META-INF/resources/webjars/)的静态资源,我们之后引入如jquery等js文件可以通过webjars打包的jar包来通过maven管理,并进行访问使用。


若是在springboot中使用jsp页面,我们导入如jquery只需要这样引入:


<script type="text/javascript" src="${pageContext.request.contextPath }/webjars/jquery/3.5.1/jquery.js"></script>


第二种:/**

我们继续看对应的第二部分代码:


//方式二:staticPathPattern="/**"
String staticPathPattern = this.mvcProperties.getStaticPathPattern();
if (!registry.hasMappingForPattern(staticPathPattern)) {
    //this.resourceProperties.getStaticLocations()可以得到静态资源路径
    customizeResourceHandlerRegistration(registry.addResourceHandler(staticPathPattern)
                                        .addResourceLocations(getResourceLocations(this.resourceProperties.getStaticLocations()))
                                         .setCachePeriod(getSeconds(cachePeriod)).setCacheControl(cacheControl)
                                         .setUseLastModified(this.resourceProperties.getCache().isUseLastModified()));
}


①我们从何得知staticPathPattern="/**"?


我们点入this.mvcProperties.getStaticPathPattern()方法进入到WebMvcProperties类中的方法如下:


public String getStaticPathPattern() {
   return this.staticPathPattern;
}


//继续点击 依旧是WebMvcProperties类里的 this.staticPathPattern即可查看对应路径
private String staticPathPattern = "/**";


② 此时我们知道静态资源路径为/**,那么映射到本地路径哪里呢?


我们点击对应getStaticLocations()方法,进入到WebProperties类中的方法如下:


public String[] getStaticLocations() {
   return this.staticLocations;
}


// 继续点击到达  WebProperties类里的一个内部类Resources
private String[] staticLocations = CLASSPATH_RESOURCE_LOCATIONS;
//点击常量CLASSPATH_RESOURCE_LOCATIONS 依旧是Resouces类里 此时查看到对应映射路径
private static final String[] CLASSPATH_RESOURCE_LOCATIONS = { "classpath:/META-INF/resources/",
"classpath:/resources/", "classpath:/static/", "classpath:/public/" };


分别是下面四个路径:


classpath:/META-INF/resources/:指的是第三方jar包中的资源

classpath:/resources/:指的是src/resources/resources

classpath:/static/:指的是src/resources/static/

classpath:/public/:指的是src/resources/public/



也就是我们通过/*即可访问到对应resources下三个目录的资源,其中static仅仅是创建工程默认自带给我们放置资源的。


启动项目来进行访问测试:直接/后面写资源名称即可映射到对应目录中,这里三个js中仅仅写数字来测试



③不同目录下其优先级是如何排序的?


我们通过测试,可以得知resources>static>public,分别按照优先级进行排序


自定义路径(不推荐)

我们知道这个WebMvcAutoConfiguration配置类是spring.factories中的,在启动类中会自动对其下的配置类进行自动配置



我们点进WebMvcAutoConfiguration中查看其内部类,上面的静态资源配置也是在这个适配器中



说了一大堆,进入正题,我们在第二种/**这个路径值的获取时就是通过这个WebMvcProperties这个类的一个属性获取:


@ConfigurationProperties(prefix = "spring.mvc")
public class WebMvcProperties {
    ...
  private String staticPathPattern = "/**";
    ...
}


因为其是自动配置类,那么也就是说我们也可以通过yaml配置文件来进行配置其静态资源的路径了:


ok,我们在application.yaml配置文件中进行配置:


spring.mvc.static-path-pattern=/changlu/**


此时默认路径就像这里浏览器访问的一样了,我们已经修改了访问路径,试验一下:



说明:这里只是一种更改静态路径的方式,还有通过自定义静态资源映射类来进行更改,不过不推荐更改


总结

使用如下方式来处理静态资源


第一种:/webjars/**,浏览器访问localhost:8080/webjars/,对应第三方jar包下的classpath:/META-INF/resources/webjars/,可以去webjars官网获取依赖jar包


第二种:/**,浏览器访问localhost:8080/,对应四个路径下,/resources/resources /resouces/static /resources/public 以及classpath:/META-INF/resources/


其优先级为resources>static>public,默认项目会自带一个static目录


三个目录经常使用如下:


public:公共的资源

static:图片等等

resource:upload上传的文件

解决访问不了静态路径下的资源

我在static目录下添加了几个文件,接着我在浏览器中访问http://localhost:8080/css/bootstrap.css,就跳转了错误页面



解决方案:


使用maven自带的clean,清除一下,最好再清除一下浏览器缓存,再次访问即可解决!


二、自定义首页及favion


自定义首页

在springboot,也早就自定义好了默认的首页位置,我们往下看


依旧是在WebMvcAutoConfiguration的内部类EnableWebMvcConfiguration中:



这个内部类中使用了@Bean来自动注册WelcomePageHandlerMapping


/**
 * Configuration equivalent to {@code @EnableWebMvc}.
 */
@Configuration(proxyBeanMethods = false)
@EnableConfigurationProperties(WebProperties.class)
public static class EnableWebMvcConfiguration extends DelegatingWebMvcConfiguration implements ResourceLoaderAware {
    @Bean
  public WelcomePageHandlerMapping welcomePageHandlerMapping(ApplicationContext applicationContext,
    FormattingConversionService mvcConversionService, ResourceUrlProvider mvcResourceUrlProvider) {
    WelcomePageHandlerMapping welcomePageHandlerMapping = new WelcomePageHandlerMapping(
      new TemplateAvailabilityProviders(applicationContext), applicationContext,
                    //这里构造器的参数调用了这个方法,我们往下找
                    getWelcomePage(),
      this.mvcProperties.getStaticPathPattern());
    welcomePageHandlerMapping.setInterceptors(getInterceptors(mvcConversionService, mvcResourceUrlProvider));
    welcomePageHandlerMapping.setCorsConfigurations(getCorsConfigurations());
    return welcomePageHandlerMapping;
  }
      private Optional<Resource> getWelcomePage() {
        //获取到四个静态资源默认路径,就是上面/**对应的资源路径
  String[] locations = getResourceLocations(this.resourceProperties.getStaticLocations());
        //这里使用了jdk1.8新特性stream的map方法来进行合并路径也就是对应四个路径下,来进行依次访问
  return Arrays.stream(locations).map(this::getIndexHtml).filter(this::isReadable).findFirst();
  }
  private Resource getIndexHtml(String location) {
            //例如classpath:/resources/index.html
    return this.resourceLoader.getResource(location + "index.html");
  }
    ...
}



也就是说我们只需要放置在对应/*映射的四个目录下即可进行访问对应的首页,访问localhost:8080/即可:



若是三个目录下都有index.html,那么对应的优先级如下:resource>static>public



这里扩展一下,在templates中放置index.html,如何访问?


这里的templates目录就相当于之前web项目里的web-inf目录中,只能通过controller来进行个跳转访问。


我们在templates中放入index.html,并且编写一个controller程序来测试一下:


//这里是返回modelandview , springboot已经帮我们将静态资源配置配好了
@Controller
public class HelloController {
    @RequestMapping("/")
    public String hello(){
        return "index";
    }
}


这还不够,要想访问templates目录中的资源,还需要添加thymeleaf依赖,我们导入pom.xml依赖:


<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>


或者在创建springboot项目时进行选择模板:



接下来我们访问一下吧:localhost:8080/,即可自动访问到templates目录下的index.html(就算其他静态资源有index.html):



favion图标

对于springboot2.1.7版本,我们设置favion图标,我们仅仅需要在yaml配置文件中这样设置:


# 消除springboot初始图标
spring:
 favicon:
  enabled: false


接着将favion图标(.ico结尾)放在对应四个静态资源目录下即可生效


说明:Spring Boot项目的issues中提出,如果提供默认的Favicon可能会导致网站信息泄露


对应springboot 2.4.1,移除了图标


参考文章:(解答)SpringBoot从2.1.X过渡到2.2.X后,网站图标favicon.ico去哪了?


经过测试了之后,单独将favicon.ico的图标直接放置static目录下即可生效!!!


我们对需要图标的标签中添加如下内容即可获取:


<link rel="icon" href="assets/img/favicon.ico">


对应前后端分离,我们后端的本就不用去管前端的页面了!!!


相关文章
|
12天前
|
Java 数据库连接 测试技术
SpringBoot入门(4) - 添加内存数据库H2
SpringBoot入门(4) - 添加内存数据库H2
37 4
SpringBoot入门(4) - 添加内存数据库H2
|
8天前
|
设计模式 前端开发 数据库
Python Web开发:Django框架下的全栈开发实战
【10月更文挑战第27天】本文介绍了Django框架在Python Web开发中的应用,涵盖了Django与Flask等框架的比较、项目结构、模型、视图、模板和URL配置等内容,并展示了实际代码示例,帮助读者快速掌握Django全栈开发的核心技术。
84 44
|
1天前
|
Java 应用服务中间件 数据库连接
SpringBoot入门(2) - SpringBoot HelloWorld
SpringBoot入门(2) - SpringBoot HelloWorld
14 2
SpringBoot入门(2) - SpringBoot HelloWorld
|
1天前
|
缓存 IDE Java
SpringBoot入门(7)- 配置热部署devtools工具
SpringBoot入门(7)- 配置热部署devtools工具
9 2
 SpringBoot入门(7)- 配置热部署devtools工具
|
12天前
|
Java 应用服务中间件 数据库连接
SpringBoot入门(2) - SpringBoot HelloWorld
SpringBoot入门(2) - SpringBoot HelloWorld
14 2
SpringBoot入门(2) - SpringBoot HelloWorld
|
7天前
|
Java 数据库连接 测试技术
SpringBoot入门(4) - 添加内存数据库H2
SpringBoot入门(4) - 添加内存数据库H2
44 13
|
2天前
|
Java 中间件
SpringBoot入门(6)- 添加Logback日志
SpringBoot入门(6)- 添加Logback日志
24 5
|
1天前
|
前端开发 Java 数据库
SpringBoot入门(3) - 对Hello world进行MVC分层
SpringBoot入门(3) - 对Hello world进行MVC分层
13 4
|
1天前
|
Java 数据库连接 测试技术
SpringBoot入门(4) - 添加内存数据库H2
SpringBoot入门(4) - 添加内存数据库H2
14 4
|
4天前
|
前端开发 API 开发者
Python Web开发者必看!AJAX、Fetch API实战技巧,让前后端交互如丝般顺滑!
在Web开发中,前后端的高效交互是提升用户体验的关键。本文通过一个基于Flask框架的博客系统实战案例,详细介绍了如何使用AJAX和Fetch API实现不刷新页面查看评论的功能。从后端路由设置到前端请求处理,全面展示了这两种技术的应用技巧,帮助Python Web开发者提升项目质量和开发效率。
13 1
下一篇
无影云桌面