Spring与Web

在 Web 项目中使用 Spring 框架，首先要解决在 web 层（这里指 Servlet）中获取到 Spring容器的问题。只要在 web 层获取到了 Spring 容器，便可从容器中获取到 Service 对象

一、Web项目中使用Spring

1. 新建一个Maven项目

此时选择的就是maven-archetype-webapp

2. 使用之前的案例

还是使用Spring集成MyBatis那个案例的代码，目录如下

1. service层、Dao层，domain全部代码复制
2. 配置文件applicationContext.xml、jdbc.properties，mybatis.xml，复制
3. pom.xml、主要新增加入servlet，jsp依赖

这里还是直接把整个的pom.xml文件放在下面

  4.0.0

  com.md
  10-spring-web
  1.0-SNAPSHOT
  war

  
    UTF-8
    1.8
    1.8
  

  

    
    
      junit
      junit
      4.11
      test
    

    
    
      org.springframework
      spring-context
      5.2.5.RELEASE
    

    
    
      org.springframework
      spring-tx
      5.2.5.RELEASE
    
    
      org.springframework
      spring-jdbc
      5.2.5.RELEASE
    


    
    
      org.mybatis
      mybatis
      3.5.1
    

    
    
      org.mybatis
      mybatis-spring
      1.3.1
    

    
    
      mysql
      mysql-connector-java
      5.1.9
    


    
    
      com.alibaba
      druid
      1.1.12
    

    
    
      javax.servlet
      javax.servlet-api
      3.1.0
      provided
    
    
    
      javax.servlet.jsp
      jsp-api
      2.2.1-b03
      provided
    


    
    
      org.springframework
      spring-web
      5.2.5.RELEASE
    


  

  

    
    
      
        src/main/java
        
          **/*.properties
          **/*.xml
        
        false
      
    



  

3. 定义index页面

<%--
  Created by IntelliJ IDEA.
  User: MD
  Date: 2020/8/11
  Time: 15:12
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>


    


    
学生注册
    

        

            

                
id
                

            

            

                
姓名：
                

            
            

                
email：
                

            
            

                
年龄
                

            

            

                

                

            
        


    

4. 定义RegisterServlet

在com.md下新建一个包controller，在下面创建RegisterServlet，继承HttpServlet

package com.md.controller;

import com.md.domain.Student;
import com.md.service.StudentService;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.context.support.WebApplicationContextUtils;

import javax.servlet.ServletContext;
import javax.servlet.ServletContextListener;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

/**
 * @author MD
 * @create 2020-08-11 15:22
 */
public class RegisterServlet extends HttpServlet {
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        request.setCharacterEncoding("UTF-8");

        String strId = request.getParameter("id");
        String strName = request.getParameter("name");
        String strEmail = request.getParameter("email");
        String strAge = request.getParameter("age");

        // 创建spring的容器对象
        String config = "spring.xml";
        ApplicationContext c = new ClassPathXmlApplicationContext(config);

        // 获取service
        StudentService studentService = (StudentService) c.getBean("studentService");
        studentService.addStudent(new Student(Integer.parseInt(strId),
                                strName,strEmail,Integer.parseInt(strAge)));


        // 跳的另一个页面
        request.getRequestDispatcher("/result.jsp").forward(request,response);

    }
}

5. 定义result页面

<%--
  Created by IntelliJ IDEA.
  User: MD
  Date: 2020/8/11
  Time: 15:30
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>


    



注册成功

6. web.xml 注册 Servlet

    

    
        RegisterServlet
        com.md.controller.RegisterServlet
    
    
        RegisterServlet
        /reg
    
    

此时和java web类似，配置Tomcat，启动，然后运行

7. 运行结果分析

当表单提交，跳转到 result.jsp 后，多刷新几次页面，查看后台输出，发现每刷新一次页面，就 new 出一个新的 Spring 容器。即，每提交一次请求，就会创建一个新的 Spring 容器

对于一个应用来说，只需要一个 Spring 容器即可。所以，将 Spring 容器的创建语句放在 Servlet 的 doGet()或 doPost()方法中是有问题的，需要改进

二、 使用 Spring 的器监听器 ContextLoaderListener

对于 Web 应用来说，ServletContext 对象是唯一的，一个 Web 应用，只有一个ServletContext 对象，该对象是在 Web 应用装载时初始化的。

若将 Spring 容器的创建时机，放在 ServletContext 初始化时，就可以保证 Spring 容器的创建只会执行一次，也就保证了Spring 容器在整个应用中的唯一性

当 Spring 容器创建好后，在整个应用的生命周期过程中，Spring 容器应该是随时可以被访问的。即，Spring 容器应具有全局性。而放入 ServletContext 对象的属性，就具有应用的全局性。所以，将创建好的 Spring 容器，以属性的形式放入到 ServletContext 的空间中，就保证了 Spring 容器的全局性

上述的这些工作，已经被封装在了如下的 Spring 的 Jar 包的相关 API 中：spring-web-5.2.5.RELEASE

1. maven依赖pom.xml

      org.springframework
      spring-web
      5.2.5.RELEASE
    

2. 注册监听器 ContextLoaderListener

若 要 在 ServletContext 初 始 化 时 创 建 Spring 容 器 ， 就 需 要 使 用 监 听 器 接 口ServletContextListener 对 ServletContext 进行监听。在 web.xml 中注册该监听器

        org.springframework.web.context.ContextLoaderListener
    

3. 指定 Spring 配置文件的位置

ContextLoaderListener 在对 Spring 容器进行创建时，需要加载 Spring 配置文件。其默认的 Spring 配置文件位置与名称为：WEB-INF/applicationContext.xml。

但一般会将该配置文件放置于项目的 classpath 下，即 src 下，所以需要在 web.xml 中对 Spring 配置文件的位置及名称进行指定

此时为了和默认的不同，把applicationContext.xml重命名为spring.xml文件

        
        contextConfigLocation
        
        classpath:spring.xml
    

此时web.xml中的全部代码

    


    
        RegisterServlet
        com.md.controller.RegisterServlet
    
    
        RegisterServlet
        /reg
    
    
    
    


    
        
        contextConfigLocation
        
        classpath:spring.xml
    

    
    
        org.springframework.web.context.ContextLoaderListener
    

此时的目录结构

4. 获取Spring容器对象

1. 直接从 ServletContext 中获取

        WebApplicationContext c = null;
        // 获取ServletContext中的容器对象,创建好的容器对象
        String key = WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE;
        Object attr = getServletContext().getAttribute(key);
        if (attr != null){
            c = (WebApplicationContext) attr;
        }

2. 通过 WebApplicationContextUtils 获取

// 使用框架中的方法获取容器对象
        WebApplicationContext c = null;
        ServletContext sc = getServletContext();
        c = WebApplicationContextUtils.getRequiredWebApplicationContext(sc);

        System.out.println("容器对象的信息--------"+c);

以上两种方式，无论使用哪种获取容器对象，刷新 result页面后，可看到代码中使用的 Spring 容器均为同一个对象

此时RegisterServlet的全部代码

package com.md.controller;

import com.md.domain.Student;
import com.md.service.StudentService;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.context.support.WebApplicationContextUtils;

import javax.servlet.ServletContext;
import javax.servlet.ServletContextListener;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

/**
 * @author MD
 * @create 2020-08-11 15:22
 */
public class RegisterServlet extends HttpServlet {
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        request.setCharacterEncoding("UTF-8");

        String strId = request.getParameter("id");
        String strName = request.getParameter("name");
        String strEmail = request.getParameter("email");
        String strAge = request.getParameter("age");

        // 创建spring的容器对象
        //String config = "spring.xml";
        //ApplicationContext c = new ClassPathXmlApplicationContext(config);


        // 配置完成之后可以直接这么使用


//        WebApplicationContext c = null;
//        // 获取ServletContext中的容器对象,创建好的容器对象
//        String key = WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE;
//        Object attr = getServletContext().getAttribute(key);
//        if (attr != null){
//            c = (WebApplicationContext) attr;
//        }


        // 使用框架中的方法获取容器对象，推荐
        WebApplicationContext c = null;
        ServletContext sc = getServletContext();
        c = WebApplicationContextUtils.getRequiredWebApplicationContext(sc);
        
        // 直接缩短为一行
 //WebApplicationContext c = WebApplicationContextUtils.getRequiredWebApplicationContext(getServletContext());
        System.out.println("容器对象的信息--------"+c);




        // 获取service
        StudentService studentService = (StudentService) c.getBean("studentService");
        studentService.addStudent(new Student(Integer.parseInt(strId),
                                strName,strEmail,Integer.parseInt(strAge)));


        // 跳的另一个页面
        request.getRequestDispatcher("/result.jsp").forward(request,response);

    }
}