IDEA02 利用Maven创建Web项目、为Web应用添加Spring框架支持、bean的创建于获取、利用注解配置Bean、自动装配Bean、MVC配置 - CRUD_Architect - 博客园

IDEA02 利用Maven创建Web项目、为Web应用添加Spring框架支持、bean的创建于获取、利用注解配置Bean、自动装配Bean、MVC配置

 

1 环境版本说明

  Jdk : 1.8

  Maven : 3.5 

  IDEA : 专业版 2017.2

 

2 环境准备

  2.1 Maven安装及其配置

  2.2 Tomcat安装及其配置

 

3 详细步骤

  3.1 根据模板创建maven工程

    file -> new -> project -> maven -> webapp

    技巧01:根据模板创建web工程时,请选择 maven-archetype-webapp 

  3.2 目录结构调整

    项目创建成功后的目录结构如下:

    跳坑01:新创建的项目中没有存放源文件的java文件夹,也没有存放测试文件的test文件夹,同样没有存放资源文件的resources文件夹

    跳坑01:在main目录下新建java、resources两个文件夹,分别用来存放源文件和资源文件;在main的同级目录中新建test目录用来存放测试文件夹

    技巧01:虽然我们创建了相关的文件夹,但是IDEA并不知道java文件夹是用来存放源文件,test用来存放测试文件,resources用来存放资源文件的;我们必须进行手动配置:

      file -> project structure -> modules

    设置完后整个目录结构如下:

  3.3 配置tomcat

    3.3.1 打开启动配置页面

    3.3.2 添加tomcat启动项

    3.3.3 配置tomcat基本信息

    3.3.4 添加web模块

      技巧01:为项目添加一个web模块,file -> project structure -> module 

      跳坑01:利用IDEA创建项目时会在main目录下创建一个webapp文件夹,该文件夹里面的内容就是需要被部署到tomcat容器的内容,但是我们为项目添加了web模块后会自动在项目的根目录下生成一个web文件夹【建议将这个web文件夹删掉】,这个文件夹的作用和main目录下的webapp文件夹的作用相同,而且添加web模块时自动寻找的是新创建的web文件夹下面的web.xml文件;将web.xml改成webapp下面的web.xml,并将web的源文件文件夹改成webapp,修改后的效果如下:

    3.3.5 添加artifacts

      技巧01:添加一个web应用,这个web引用来源于modules【其实就是来源于我们创建的web工程】

    3.3.6 配置发布页面

      将 artifacts 中配置为web应用添加到tomcat配置中的deployment

 

    3.3.7 配置开发热部署

      就是修改前后台代码后不用重启tomcat,IDEA会自动进行【修改后台时自动重启tomcat服务器,修改前台时刷新浏览器就可以啦】

    3.3.8 启动测试

      直接通过IDEA启动tomcat就可以啦

      技巧01:应用启动成功后,会自动访问webapp里面的index.jsp页面

 

4 添加框架支持

  我们创建的Web应用知识一个架子,不过IDEA支持自动添加框架;这样就不需要手动在pom.xml中添加相关框架的依赖配置了

  右键项目 -> add framework stupport 

  技巧01:本博文主要添加spring框架的支持

  技巧02:点击确认后会自动将spring框架的依赖包下载到项目中去【PS: 是直接将依赖下载到项目中的lib目录下】,整个过程有点花时间

  跳坑01:如果下载依赖期间由于网络原因失败,这时候就需要重新添加框架;但是这时候发现已经没有spring相关的选项了

  填坑01:这是后就需要进入到项目结构中的modules配置中,将spring相关的模块删除,在重新进行框架添加

  技巧03:添加完spring框架支持后会在webapp文件夹下自动生成相关的配置文件,并在webapp中的web.xml中对这些配置文件记性监听配置

 

5 Bean相关

  Bean相关的详细内容请参见《精通spring4.x企业应用开发实战》

  5.1 配置bean

    5.1.1 准备

      在pom.xml文件中引入lombok依赖

      创建Student类和Teacher类

package domain;

import lombok.Data;

/**
 * @author 王杨帅
 * @create 2018-08-10 20:43
 * @desc 學生實體類
 **/
@Data
public class Student {

    private String id;
    private String name;
    private Integer age;
    private String address;

    public void info() {
        System.out.println("我是學生,我在學習控制反轉相關知識點。");
    }

}
Student.java
package domain;

/**
 * @author 王杨帅
 * @create 2018-08-10 20:45
 * @desc 老師實體類
 **/
public class Teacher {

    private String id;
    private String name;
    private Integer age;
    private String address;

    public void info() {
        System.out.println("我是老师,我在教授IOC相关知识点。");
    }

}
Teacher.java

    5.1.2 利用xml配置

      技巧01:需要将配置文件放到resources文件夹下【之前通过添加spring框架支持时产生的配置文件位于webapp下面,移动后需要更改web.xml配置文件???待修改】

<?xml version="1.0" encoding="utf-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">

    <bean id="student" class="domain.Student"></bean>

</beans>
View Code

    5.1.3 利用类注解配置

package core.config;

import domain.Teacher;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @author 王杨帅
 * @create 2018-08-10 20:59
 * @desc bean配置类
 **/
@Configuration
public class Beans {

    @Bean(value = "teacher")
    public Teacher buildTeacher() {
        return new Teacher();
    }

}
Beans.java

  5.2 获取bean

     5.2.1 利用BeanFactory获取

    /**
     * 利用BeanFactory获取bean
     * @throws IOException
     */
    @Test
    public void test01() throws IOException {
        System.out.println("Hello Boy");
        ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
        Resource resource = resolver.getResource("classpath:applicationContext.xml");

        System.out.println(resource.getURL());

        DefaultListableBeanFactory factory = new DefaultListableBeanFactory();
        XmlBeanDefinitionReader reader = new XmlBeanDefinitionReader(factory);
        reader.loadBeanDefinitions(resource);

        System.out.println("初始化BeanFactory完毕");

        Student student = factory.getBean("student", Student.class);
        System.out.println("student bean 获取成功");

        student.info();

    }
View Code

    5.2.2. 利用ApplicationContext获取

      技巧01:利用ApplicationContext获取xml配置的bean和配置类配置的bean需要用不同的实现类

    /**
     * 利用ApplicationContext獲取bean
     */
    @Test
    public void test02() {
        ApplicationContext applicationContext = new ClassPathXmlApplicationContext("classpath:applicationContext.xml");
        Student student = applicationContext.getBean("student", Student.class);

        student.info();
    }

    /**
     * 利用ApplicationContext获取配置类配置的bean
     */
    @Test
    public void test03() {
        ApplicationContext applicationContext = new AnnotationConfigApplicationContext(Beans.class);
        Teacher teacher = applicationContext.getBean("teacher", Teacher.class);

        teacher.info();

    }
View Code

    5.2.3 获取bean代码汇总

package domain;

import core.config.Beans;
import org.junit.Before;
import org.junit.Test;
import org.springframework.beans.factory.support.DefaultListableBeanFactory;
import org.springframework.beans.factory.xml.XmlBeanDefinitionReader;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.core.io.support.ResourcePatternResolver;

import java.io.IOException;

/**
 * @author 王杨帅
 * @create 2018-08-10 20:47
 * @desc 测试类
 **/
public class TestDemo {

    @Before
    public void init() {
        System.out.println("初始化方法");
    }

    /**
     * 利用BeanFactory获取bean
     * @throws IOException
     */
    @Test
    public void test01() throws IOException {
        System.out.println("Hello Boy");
        ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
        Resource resource = resolver.getResource("classpath:applicationContext.xml");

        System.out.println(resource.getURL());

        DefaultListableBeanFactory factory = new DefaultListableBeanFactory();
        XmlBeanDefinitionReader reader = new XmlBeanDefinitionReader(factory);
        reader.loadBeanDefinitions(resource);

        System.out.println("初始化BeanFactory完毕");

        Student student = factory.getBean("student", Student.class);
        System.out.println("student bean 获取成功");

        student.info();

    }

    /**
     * 利用ApplicationContext獲取bean
     */
    @Test
    public void test02() {
        ApplicationContext applicationContext = new ClassPathXmlApplicationContext("classpath:applicationContext.xml");
        Student student = applicationContext.getBean("student", Student.class);

        student.info();
    }

    /**
     * 利用ApplicationContext获取配置类配置的bean
     */
    @Test
    public void test03() {
        ApplicationContext applicationContext = new AnnotationConfigApplicationContext(Beans.class);
        Teacher teacher = applicationContext.getBean("teacher", Teacher.class);

        teacher.info();

    }

}
View Code

    

6 web.xml配置

  6.1 当前项目出现的问题

    由于我们在5.1.2的时候将bean相关的配置文件都移动到了resources目录下,但是web.xml中还没有做对应的修改;默认web.xml的配置文件是放在WEB-INF下面的,默认的web.xml配置文件信息如下

    我们将配置文件移动到resources目录下后,在不更改web.xml配置文件的情况下启动taomcat运行项目的报错信息如下(报错原因就是web.xml的配置中还是在WEB-INF下面去寻找配置文件,但是我们已经将配置文件移动到了resources目录下,所以会报IO异常):

  6.2 修改web.xml中的配置文件路径

    技巧01:如果在web.xml中不写任何参数配置信息,默认的路径是"/WEB-INF/applicationContext.xml,  在WEB-INF目录下创建的xml文件的名称必须是applicationContext.xml

    技巧02:可以同时配置多个配置文件路径信息,它们之间用逗号隔开

  6.3 再次启动的效果

    启动结果:修改完web.xml中的配置文件路径后,再次启动容器时,虽然可以正常启动,但是在启动时会报一个错误,错误信息如下:

    报错原因:使用springMVC时需要配置DispatcherServlet, DispatcherServlet 需要一个配置文件,该配置文件的默认值时WEB-INF下面的dispatcher-servlet.xml,我们已经将其移动到了resouces目录下,所以会报错。

    解决办法:在配置DispatcherServlet 时利用 <init-param>  重新指定默认配置文件的位置【PS: 随便指定一个即可,本案例指定的是一个空的配置文件dispatcher-servlet.xml】

  6.4 web.xml配置详情

<?xml version="1.0" encoding="utf-8"?>  
<web-app version="3.0" xmlns="http://java.sun.com/xml/ns/javaee"  
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
         xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">  

    <!-- 在Spring框架中是如何解决从页面传来的字符串的编码问题的呢?
    下面我们来看看Spring框架给我们提供过滤器CharacterEncodingFilter  
     这个过滤器就是针对于每次浏览器请求进行过滤的,然后再其之上添加了父类没有的功能即处理字符编码。  
      其中encoding用来设置编码格式,forceEncoding用来设置是否理会 request.getCharacterEncoding()方法,设置为true则强制覆盖之前的编码格式。-->  
    <filter>  
        <filter-name>characterEncodingFilter</filter-name>  
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>  
        <init-param>  
            <param-name>encoding</param-name>  
            <param-value>utf-8</param-value>  
        </init-param>  
        <init-param>  
            <param-name>forceEncoding</param-name>  
            <param-value>true</param-value>  
        </init-param>  
    </filter>  
    <filter-mapping>  
        <filter-name>characterEncodingFilter</filter-name>  
        <url-pattern>/*</url-pattern>  
    </filter-mapping>  
    <!-- 项目中使用Spring 时,applicationContext.xml配置文件中并没有BeanFactory,要想在业务层中的class 文件中直接引用Spring容器管理的bean可通过以下方式-->  
    <!--1、在web.xml配置监听器ContextLoaderListener-->  
    <!--ContextLoaderListener的作用就是启动Web容器时,自动装配ApplicationContext的配置信息。因为它实现了ServletContextListener这个接口,在web.xml配置这个监听器,启动容器时,就会默认执行它实现的方法。  
    在ContextLoaderListener中关联了ContextLoader这个类,所以整个加载配置过程由ContextLoader来完成。  
    它的API说明  
    第一段说明ContextLoader可以由 ContextLoaderListener和ContextLoaderServlet生成。  
    如果查看ContextLoaderServlet的API,可以看到它也关联了ContextLoader这个类而且它实现了HttpServlet这个接口  
    第二段,ContextLoader创建的是 XmlWebApplicationContext这样一个类,它实现的接口是WebApplicationContext->ConfigurableWebApplicationContext->ApplicationContext->  
    BeanFactory这样一来spring中的所有bean都由这个类来创建  
     IUploaddatafileManager uploadmanager = (IUploaddatafileManager)    ContextLoaderListener.getCurrentWebApplicationContext().getBean("uploadManager");
     -->  
    <listener>  
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>  
    </listener>  
    <!--2、部署applicationContext的xml文件-->  
    <!--如果在web.xml中不写任何参数配置信息,默认的路径是"/WEB-INF/applicationContext.xml,  
    在WEB-INF目录下创建的xml文件的名称必须是applicationContext.xml。  
    如果是要自定义文件名可以在web.xml里加入contextConfigLocation这个context参数:  
    在<param-value> </param-value>里指定相应的xml文件名,如果有多个xml文件,可以写在一起并以“,”号分隔。  
    也可以这样applicationContext-*.xml采用通配符,比如这那个目录下有applicationContext-ibatis-base.xml,  
    applicationContext-action.xml,applicationContext-ibatis-dao.xml等文件,都会一同被载入。  
    在ContextLoaderListener中关联了ContextLoader这个类,所以整个加载配置过程由ContextLoader来完成。-->  
    <context-param>  
        <param-name>contextConfigLocation</param-name>  
        <param-value>classpath:spring/applicationContext.xml</param-value>  
    </context-param>  

    <!--如果你的DispatcherServlet拦截"/",为了实现REST风格,拦截了所有的请求,那么同时对*.js,*.jpg等静态文件的访问也就被拦截了。-->  
    <!--方案一:激活Tomcat的defaultServlet来处理静态文件-->  
    <!--要写在DispatcherServlet的前面, 让 defaultServlet先拦截请求,这样请求就不会进入Spring了,我想性能是最好的吧。-->  
    <servlet-mapping>  
        <servlet-name>default</servlet-name>  
        <url-pattern>*.css</url-pattern>  
    </servlet-mapping>  
    <servlet-mapping>  
        <servlet-name>default</servlet-name>  
        <url-pattern>*.swf</url-pattern>  
    </servlet-mapping>  
    <servlet-mapping>  
        <servlet-name>default</servlet-name>  
        <url-pattern>*.gif</url-pattern>  
    </servlet-mapping>  
    <servlet-mapping>  
        <servlet-name>default</servlet-name>  
        <url-pattern>*.jpg</url-pattern>  
    </servlet-mapping>  
    <servlet-mapping>  
        <servlet-name>default</servlet-name>  
        <url-pattern>*.png</url-pattern>  
    </servlet-mapping>  
    <servlet-mapping>  
        <servlet-name>default</servlet-name>  
        <url-pattern>*.js</url-pattern>  
    </servlet-mapping>  
    <servlet-mapping>  
        <servlet-name>default</servlet-name>  
        <url-pattern>*.html</url-pattern>  
    </servlet-mapping>  
    <servlet-mapping>  
        <servlet-name>default</servlet-name>  
        <url-pattern>*.xml</url-pattern>  
    </servlet-mapping>  
    <servlet-mapping>  
        <servlet-name>default</servlet-name>  
        <url-pattern>*.json</url-pattern>  
    </servlet-mapping>  
    <servlet-mapping>  
        <servlet-name>default</servlet-name>  
        <url-pattern>*.map</url-pattern>  
    </servlet-mapping>  
    <!--使用Spring MVC,配置DispatcherServlet是第一步。DispatcherServlet是一个Servlet,,所以可以配置多个DispatcherServlet-->  
    <!--DispatcherServlet是前置控制器,配置在web.xml文件中的。拦截匹配的请求,Servlet拦截匹配规则要自已定义,把拦截下来的请求,依据某某规则分发到目标Controller(我们写的Action)来处理。-->  
    <servlet>  
        <servlet-name>DispatcherServlet</servlet-name><!--在DispatcherServlet的初始化过程中,框架会在web应用的 WEB-INF文件夹下寻找名为[servlet-name]-servlet.xml 的配置文件,生成文件中定义的bean。-->  
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>  
        <!--指明了配置文件的文件名,不使用默认配置文件名,而使用dispatcher-servlet.xml配置文件。-->  
        <init-param>  
            <param-name>contextConfigLocation</param-name>  
            <!--其中<param-value>**.xml</param-value> 这里可以使用多种写法-->  
            <!--1、不写,使用默认值:/WEB-INF/<servlet-name>-servlet.xml-->  
            <!--2、<param-value>/WEB-INF/classes/dispatcher-servlet.xml</param-value>-->  
            <!--3、<param-value>classpath*:dispatcher-servlet.xml</param-value>-->  
            <!--4、多个值用逗号分隔-->  
            <param-value>classpath:spring/dispatcher-servlet.xml</param-value>  
        </init-param>  
        <load-on-startup>1</load-on-startup><!--是启动顺序,让这个Servlet随Servletp容器一起启动。-->  
    </servlet>  
    <servlet-mapping>  
        <!--这个Servlet的名字是dispatcher,可以有多个DispatcherServlet,是通过名字来区分的。每一个DispatcherServlet有自己的WebApplicationContext上下文对象。同时保存的ServletContext中和Request对象中.-->  
        <!--ApplicationContext是Spring的核心,Context我们通常解释为上下文环境,我想用“容器”来表述它更容易理解一些,ApplicationContext则是“应用的容器”了:P,Spring把Bean放在这个容器中,在需要的时候,用getBean方法取出-->  
        <servlet-name>DispatcherServlet</servlet-name>  
        <!--Servlet拦截匹配规则可以自已定义,当映射为@RequestMapping("/user/add")时,为例,拦截哪种URL合适?-->  
        <!--1、拦截*.do、*.htm, 例如:/user/add.do,这是最传统的方式,最简单也最实用。不会导致静态文件(jpg,js,css)被拦截。-->  
        <!--2、拦截/,例如:/user/add,可以实现现在很流行的REST风格。很多互联网类型的应用很喜欢这种风格的URL。弊端:会导致静态文件(jpg,js,css)被拦截后不能正常显示。 -->  
        <url-pattern>/</url-pattern> <!--会拦截URL中带“/”的请求。-->  
    </servlet-mapping>  

    <welcome-file-list><!--指定欢迎页面-->  
        <welcome-file>login.html</welcome-file>  
    </welcome-file-list>  
    <error-page> <!--当系统出现404错误,跳转到页面nopage.html-->  
        <error-code>404</error-code>  
        <location>/nopage.html</location>  
    </error-page>  
    <error-page> <!--当系统出现java.lang.NullPointerException,跳转到页面error.html-->  
        <exception-type>java.lang.NullPointerException</exception-type>  
        <location>/error.html</location>  
    </error-page>  
    <session-config><!--会话超时配置,单位分钟-->  
        <session-timeout>360</session-timeout>  
    </session-config>  
</web-app>
View Code

    参考博文   

    

7 利用注解配置Bean

  利用XML或者java配置类来配置Bean都比较麻烦,从spring2.0开始就支持利用注解来配置Bean,常用的注解如下(详情参见《精通Spring4.x企业应用开发实战》P155):

    @Repository

    @Service

    @Controller

    @Component

  7.1 注解配置Bean实战

    7.1.1 创建一个实例

      技巧01:在该注解上添加@Component注解

      技巧02:通过注解配置Bean时默认的Bean名称是对应类的类名首字母小写后的结果,当然也可以通过注解的value属性进行指定

package domain;

import lombok.Data;
import org.springframework.stereotype.Component;

/**
 * @author 王杨帅
 * @create 2018-08-11 15:46
 * @desc
 **/
@Data
@Component
public class Dog {
    private String id;
    private String name;

    public void info() {
        System.out.println("我是哮天犬");
    }
}
Dog.java

    7.1.2 配置Bean配置注解扫描

      技巧01:在配置文件中添加扫描类包来应用注解定义的Bean

      技巧02:配置前扫描包前需要在配置文件中先进行命名空间的声明(详情参见《精通Spring4.x企业应用开发实战》P117)

    7.1.3 测试一下

    @Test
    public void test01() {
        ApplicationContext applicationContext = new ClassPathXmlApplicationContext("classpath:applicationContext.xml");
        Dog dog = applicationContext.getBean("dog", Dog.class);
        dog.info();
    }
利用应用上下文获取Bean

      跳坑01:直接利用@Autowired进行依赖注入配置好的Bean是总是失败,错误信息如下

      填坑01:参考博文

 

8 自动装配Bean

  传统的注入方式有:构造器注入、set注入(属性注入)、工厂方法注入(详情参见《精通Spring4.x企业应用开发实战》P121)

  实现依赖注入的注解有(详情参见《精通Spring4.x企业应用开发实战》P157):

    @Autowired -> 根据类型注入【推荐使用】

    @Resource -> 根据Bean名称注入

    @Inject -> 根据类型注入

 

9 MVC配置

  前后端分离的项目,后台根据不同的URL调用不同的类及其方法进行逻辑操作,操作完毕后后台需要向前台返回JSON的数据。

  9.1 配置步骤

    9.1.1 修改web.xml中DispatcherServlet配置

      技巧01:DispacherServlet是用来拦截请求的,前后端分离项目中DispacherServlet会将拦截到的请求url分发到对应的类进行逻辑处理

      技巧02:默认的DispacherServlet配置只是拦截 .form 结尾的请求url,本案例修改为拦截请求url中带 / 的所有请求

    9.1.2 利用注解编写控制层

      技巧01:控制层就是处理DispatcherServlet拦截到的请求url的类【就是进行逻辑处理的入口】

      技巧02:lombok的日志使用logback实现的,所以需要导入logback依赖

<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>1.16.20</version>
      <scope>provided</scope>
    </dependency>
    <!-- https://mvnrepository.com/artifact/ch.qos.logback/logback-classic -->
    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-classic</artifactId>
      <version>1.2.3</version>
    </dependency>
lombok和logback依赖
package cn.xiangxu.controller;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author 王杨帅
 * @create 2018-08-11 16:22
 * @desc
 **/
@RestController
@RequestMapping(value = "/test")
@Slf4j
public class TestConroller {

    @GetMapping
    public String test01() {
        String result = "前后台连接测试";
        log.info(result);
        return result;
    }

}
TestConroller.java

    9.1.3 开启MVC注解支持

 

10 本博文参考源代码

  点击下载源代码

 

11 参考博文

  项目创建 

  添加框架依赖

    web.xml配置详解

  springMVC配置详解

 

 

 

      

    

posted @ 2018-08-10 21:17 CRUD_Architect 阅读(...) 评论(...) 编辑 收藏