SpringBoot之旅第四篇-web开发

时间  2019-11-10
标签 springboot 之旅 第四 web 开发 栏目 Spring 繁體版
原文   原文链接

1、引言

有了自动配置，springboot使web开发变得简单，这个在springboot之旅中的第一篇中就有体现，实际的开发中固然不会这么简单，不少时候咱们都须要本身去定制一些东西。web开发的东西比较多， 咱们先掌握一些必要知识点，剩下的就是CRUD开发。html

2、静态资源的映射规则

如今大部分公司都是先后端分离的开发模式，通常做为后台开发不用关心前端，只须要提供相应接口，可是有关前端的知识咱们最好仍是能基本掌握一些。咱们先了一套bootstrap框架，而后开始进行开发。前端

在以前的web开发中，在main目录下面会有webapp文件夹，咱们将全部的静态资源放在里面，可是springboot的默认生成中并无这个文件夹，那么springboot是怎么映射静态资源。java

ctrl+N快捷键，找到WebMvcAutoConfiguration类，再找到里面的addResourceHandlers 方法jquery

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();
   //webjar形式
   if (!registry.hasMappingForPattern("/webjars/**")) {
      customizeResourceHandlerRegistration(registry
            .addResourceHandler("/webjars/**")
            .addResourceLocations("classpath:/META-INF/resources/webjars/")
            .setCachePeriod(getSeconds(cachePeriod))
            .setCacheControl(cacheControl));
   }
    //匹配/**
   String staticPathPattern = this.mvcProperties.getStaticPathPattern();
   if (!registry.hasMappingForPattern(staticPathPattern)) {
      customizeResourceHandlerRegistration(
            registry.addResourceHandler(staticPathPattern)
                  .addResourceLocations(getResourceLocations(
                      //映射的资源文件夹
                        this.resourceProperties.getStaticLocations()))
                  .setCachePeriod(getSeconds(cachePeriod))
                  .setCacheControl(cacheControl));
   }
}

2.1 webjars

这里的代码告诉咱们：若是是访问/webjars/**下的请求 ，都去 classpath:/META-INF/resources/webjars/ 找资源。webjars是指以jar包的方式引入静态资源。打开https://www.webjars.org/ ，能够找到咱们前端开发经常使用的一些组件，咱们选择相应的版本，例：web

 

<dependency>
  <groupId>org.webjars</groupId>
  <artifactId>jquery</artifactId>
  <version>3.3.1-1</version>
</dependency>

引入后能够看到jquer文件被引入了：spring

若是顺利的话，此时访问http://localhost:8080/webjars/jquery/3.3.1-1/jquery.js能够获得文件，结果以下：json

2.2 本身的静态文件

另外当访问当前项目的任何资源，都去（静态资源的文件夹）找映射，资源文件夹是一个数组，包括：bootstrap

"classpath:/META-INF/resources/", "classpath:/resources/","classpath:/static/", "classpath:/public/" ，后端

"/"：当前项目的根路径。只要将静态文件放入其中，那么springboot就能找到。数组

2.3 首页

在访问"/**",会去找静态资源文件夹下的全部index.html页面。

2.4 图标

全部的 **/访问都是静态资源文件下找favicon.ico。

咱们将一些静态文件放在static下，并将index.html放入public文件夹下，如图：

访问http://localhost:8080/index.html ,可获得正确返回

 

3、模板引擎

模板引擎有不少，如JSP、Velocity、Freemarker、Thymeleaf，springboot推荐的是Thymeleaf，那咱们就来简单看看Thymeleaf语法。导入starter:

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

进入以后能够看到默认版本，咱们也能够改为本身须要的版本。

<thymeleaf.version>3.0.9.RELEASE</thymeleaf.version>
<!-- 布局功能的支持程序  thymeleaf3主程序  layout2以上版本 -->
<!-- thymeleaf2   layout1-->
<thymeleaf-layout-dialect.version>2.2.2</thymeleaf-layout-dialect.version>

3.1 Thymeleaf使用

经过源码咱们知道，只要咱们把HTML页面放在classpath:/templates/，thymeleaf就能自动渲染

@ConfigurationProperties(prefix = "spring.thymeleaf")
public class ThymeleafProperties {
private static final Charset DEFAULT_ENCODING = Charset.forName("UTF-8");
private static final MimeType DEFAULT_CONTENT_TYPE = MimeType.valueOf("text/html");
public static final String DEFAULT_PREFIX = "classpath:/templates/";
public static final String DEFAULT_SUFFIX = ".html";

 

咱们能够去官网查看教程，这里只是简单的进行介绍，主要步骤

第一步：导入命名空间，导入以后会有相应提示

<html lang="en" xmlns:th="http://www.thymeleaf.org">

第二步：使用语法

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>成功！</h1>
  <!--th:text 将div里面的文本内容设置为 -->
<div><th th:text="${hello}"></th>这是显示欢迎信息</div>
</body>
</html>

 

更具体的使用方法，能够去查看官网教程，这种若是没有使用到的话不建议花太多时间去学，不少公司都是先后端分离，即便不是先后端分离，也有不少前端框架给咱们使用。这些能够再咱们使用的时候再去学习，速度也是很快的。

 

4、SpringMVC自动配置

4.1 自动配置

springboot默认将为咱们配置以下一些SpringMvc的必要组件：

  1. 必要的ViewResolver（视图解析器：根据方法的返回值获得视图对象（View）），如ContentNegotiatingViewResolver和BeanNameViewResolver。

  2. 将必要的Converter, GenericConverter, Formatter 等bean注册到ioc容器中。

  3. 添加了一系列的HttpMessageConverters以便支持对web请求和相应的类型转换。

  4. 自动配置和注册MessageCodesResolver

任什么时候候，咱们对默认提供的组件设定不满意，均可以注册新的同类型的bean定义来替换，web的全部自动场景都在org.springframework.boot.autoconfigure.web包中，咱们能够参照进行配置。

固然彻底靠自动配置在实际开发时不够的，咱们常常须要本身配置一些东西，好比拦截器，视图映射规则。

4.2 扩展配置

在sprinboot2.0以前 配置类继承WebMvcConfigurerAdapter，可是如今这个方法已通过时，如今可使用两种方式，继承WebMvcConfigurer接口或者继承WebMvcConfigurationSupport类，推荐使用的是WebMvcConfigurationSupport。

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/yuan").setViewName("success");
    }
}

 

这段代码就实现了自定义的视图映射。上面这种写法使SpringMVC的自动配置和咱们的扩展配置都会起做用

咱们甚至能够全面接管springmvc,只要在配置类中增长@EnableWebMv注解，这样全部的SpringMVC的自动配置都失效了。固然，通常状况下咱们不会这么作。

 

5、登录

web系统通常少不了登陆页面，咱们先设定默认页面为登陆页。

registry.addViewController("/").setViewName("login");
registry.addViewController("/index.html").setViewName("login");

5.1 登陆方法

具体登陆html的代码就不贴了，能够下载源码查看，新建controller

@Controller
public class LoginController {

    @PostMapping(value = "/user/login")
    public String login(@RequestParam("username") String username,
                        @RequestParam("password") String password,
                        Map<String,Object> map, HttpSession httpSession){
        if(!StringUtils.isEmpty(username)&&
        "123456".equals(password)){
             //设置session
             httpSession.setAttribute("loginUser",username);
            //重定向到主页
            return "redirect:/main.html";
        }else {
            map.put("msg","用户名密码错误");
            return "login";
        }
    }
}

 

5.2 登陆拦截器

登陆操做完成以后，为了对每一个页面进行登陆验证，咱们还须要设置登陆拦截器。先建立登陆拦截器

@Component
public class LoginHandlerInterceptor implements HandlerInterceptor {

    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        Object user = request.getSession().getAttribute("loginUser");
        if(user == null){
            //未登录，返回登录页面
            request.setAttribute("msg","没有权限请先登录");
            request.getRequestDispatcher("/index.html").forward(request,response);
            return false;
        }else{
            //已登录，放行请求
            return true;
        }
    }
}

 

而后再加入配置

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Autowired
    private LoginHandlerInterceptor loginHandlerInterceptor;
    
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(loginHandlerInterceptor).addPathPatterns("/**")
                .excludePathPatterns("/index.html","/","/user/login");
    }
 }

这样在访问其余页面时都会进行登陆拦截操做

 

6、错误处理机制

在进行开发时，错误处理是很是重要的，不论是直接显示给用户，或者返回给前端，都须要尽可能友好和清晰。

6.1 默认的错误处理机制

springboot有自身的默认错误处理机制，分为两种

第一种：浏览器，浏览器会返回一个默认的错误页面，如：

第二种：客户端，客户端默认返回的是一个响应一个json数据

若是咱们用postman访问，则返回：

6.2 定制错误响应

定制错误响应也分为两种，一种是定制错误页面，第二种是定制错误json数据。

6.2.1 定制错误页面

若是咱们想要展现更加详细的信息，就将页面放在模板引擎文件夹下，路径名为 error/状态码，【将错误页面命名为错误状态码.html 放在模板引擎文件夹里面的 error文件夹下】，发生此状态码的错误就会来到 对应的页面。在这个页面咱们能够获取到一些错误信息，如：

  • timestamp：时间戳

  • status：状态码

  • error：错误提示

  • exception：异常对象

  • message：异常消息

  • errors：JSR303数据校验的错误都在这里

咱们能够根据这些错误信息来展现错误，通常不须要这么作，抛出的错误不该该让用户去分析，咱们只须要返回静态页面便可，返回错误静态页面是作法也是同样的，只是咱们不用将文件放在模板引擎文件夹下。

6.2.2 定制错误的json数据

在实际的开发中咱们会对咱们的错误码进行规范处理，根据错误会返回相应的错误码，因此咱们会本身进行json数据包装处理。

@ControllerAdvice
public class GlobalDefaultExceptionHandler {

    @ExceptionHandler(value = RequestException.class)
    public String requestExceptionHandler(RequestException e,HttpServletRequest request){
        Map<String,Object> map = new HashMap<>();
        //传入咱们本身的错误状态码  4xx 5xx，不然就不会进入定制错误页面的解析流程
        request.setAttribute("javax.servlet.error.status_code",500);
        map.put("code","user.notexist");
        map.put("message",e.getMessage());
        //转发到/error
        return "forward:/error";
    }
}

7、配置嵌入式Servlet容器

springboot默认使用Tomcat做为嵌入式的Servlet容器，咱们既能够修改Tomcat的一些属性配置，也可使用其余的Servlet容器，咱们这篇就来学习嵌入式Servlet容器的配置。

7.1 、定制和修改Servlet容器的相关配置

servlet的配置类为ServerProperties，进入代码能够看到server可以配置的属性，咱们能够对此进行修改。

@ConfigurationProperties(prefix = "server", ignoreUnknownFields = true)
public class ServerProperties {

咱们既能够修改通用的Servlet容器设置，如：

server:
  port: 8089

也能够修改某一种容器的配置，如：

server:
  tomcat:
    uri-encoding: utf-8

7.2 、注册Servlet三大组件【Servlet、Filter、Listener】

注册三大组件用如下方式：

Servlet：ServletRegistrationBean

建立一个MyServlet类：

public class MyServlet extends HttpServlet {
    @Override
   public void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        doPost(req,resp);
    }
    @Override
   public void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
       resp.getWriter().write("hello MyServlet");
    }
}

注入容器：

@Bean
public ServletRegistrationBean myServlet(){
    ServletRegistrationBean registrationBean = new ServletRegistrationBean(new MyServlet(),"/myServlet");
    return registrationBean;
}

Filter：FilterRegistrationBean

建立MyFilter：

public class MyFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("My filter process");
        filterChain.doFilter(servletRequest,servletResponse);
    }

    @Override
    public void destroy() {

    }
}

 

注入容器：

@Bean
public FilterRegistrationBean myFilter(){
    FilterRegistrationBean registrationBean = new FilterRegistrationBean();
    registrationBean.setFilter(new MyFilter());
    registrationBean.setUrlPatterns(Arrays.asList("/hello","/myServlet"));
    return registrationBean;
}

 

Listener：ServletListenerRegistrationBean

建立MyListener：

public class MyListener implements ServletContextListener {
    @Override
    public void contextInitialized(ServletContextEvent sce) {
        System.out.println("contextInitialized ...web启动");
    }

    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        System.out.println("contextDestroyed ...web销毁");
    }
}

 

注入容器

@Bean
public ServletListenerRegistrationBean myListener(){
    ServletListenerRegistrationBean<MyListener> registrationBean = new ServletListenerRegistrationBean<>(new MyListener());
    return registrationBean;
}

7.三、 替换为其余嵌入式Servlet容器

springboot默认为tomcat容器，要替换其余容器就必须修改pom依赖

Jetty：

<!-- 引入web模块 -->
<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-web</artifactId>
   <exclusions>
      <exclusion>
         <artifactId>spring-boot-starter-tomcat</artifactId>
         <groupId>org.springframework.boot</groupId>
      </exclusion>
   </exclusions>
</dependency>

<!--引入其余的Servlet容器-->
<dependency>
   <artifactId>spring-boot-starter-jetty</artifactId>
   <groupId>org.springframework.boot</groupId>
</dependency>

 

Undertow：

<!-- 引入web模块 -->
<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-web</artifactId>
   <exclusions>
      <exclusion>
         <artifactId>spring-boot-starter-tomcat</artifactId>
         <groupId>org.springframework.boot</groupId>
      </exclusion>
   </exclusions>
</dependency>

<!--引入其余的Servlet容器-->
<dependency>
   <artifactId>spring-boot-starter-undertow</artifactId>
   <groupId>org.springframework.boot</groupId>
</dependency>

 

以上是咱们在web开发须要先掌握的一些基本技术，有了这些基本知识以后，咱们就能够进行CRUD开发，固然在实际的开发中，不论是登陆拦截仍是错误处理都比这个要复杂，咱们之后再详讲。

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程