Hurley
0%

SpringMVC 配置文件

发表于 分类于
本文字数： 9.2k 阅读时长 ≈ 8 分钟
本文主要介绍 SSM 框架中的配置整合文件。

目录规范

  • java：存放 Java 代码
  • resources：存放资源文件，例如 Spring、Mybatis、Log 的配置文件等
  • mapper：存放 dao 中每个方法对应的 sql，在这里配置就无需写 impl 实现类
  • spring：存放 Spring 的相关配置文件，有 dao、service、web 三个包
  • sql：存放数据库文件
  • webapp：存放前端的静态资源（如果是非前后端分离项目）
  • resources：前端项目的静态资源（例如图片资源等）
  • WEB-INF：外部浏览器无法访问，只有内部才可以访问。web.xml 以及 jsp 文件放置在这里
  • test：测试文件

具体包名

  • dao：是数据访问层（接口），包括数据库操作、文件读写操作、以及 Redis 缓存操作等。
  • entity：将封装 dao 层取出来的数据作为一个对象，一般用作在 dao 层和 service 层之间传递
  • dto：数据传输层，dto 有时候也叫 vo
  • service：业务逻辑层，用来设计业务接口
  • impl：业务逻辑实现层，用来实现业务接口
  • web：控制器层，或者叫 controller 包

配置文件

先在 Spring 文件夹中新建 spring-dao.xml文件。

  1. 读取数据库连接相关参数
  2. 配置数据连接池
  3. 配置连接属性
  4. 配置 SqlSessionFactory 对象（Mybatis）
  5. 扫描 dao 层接口，动态实现 dao 接口
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
<!-- spring-dao.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"
	xmlns:context="http://www.springframework.org/schema/context"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
	http://www.springframework.org/schema/beans/spring-beans.xsd
	http://www.springframework.org/schema/context
	http://www.springframework.org/schema/context/spring-context.xsd">

    <!-- 配置整合 mybatis 过程 -->
    <!-- 1. 配置数据库相关参数 properties 的属性：${url} -->
    <context:property-placeholder location="classpath:jdbc.properties" />

    <!-- 2. 数据库连接池 -->
    <bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
        <!-- 配置连接池属性 -->
        <property name="driverClass" value="${jdbc.driver}" />
        <property name="jdbcUrl" value="${jdbc.url}" />
        <property name="user" value="${jdbc.username}" />
        <property name="password" value="${jdbc.password}" />

        <!-- c3p0 连接池的私有属性 -->
        <property name="maxPoolSize" value="30" />
        <property name="minPoolSize" value="10" />
        <!-- 关闭连接后不自动 commit -->
        <property name="autoCommitOnClose" value="false" />
        <!-- 获取连接超时时间 -->
        <property name="checkoutTimeout" value="10000" />
        <!-- 当获取连接失败重试次数 -->
        <property name="acquireRetryAttempts" value="2" />
    </bean>

    <!-- 3. 配置 SqlSessionFactory 对象 -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <!-- 注入数据库连接池 -->
        <property name="dataSource" ref="dataSource" />
        <!-- 配置 MyBaties 全局配置文件：mybatis-config.xml -->
        <property name="configLocation" value="classpath:mybatis-config.xml" />
        <!-- 扫描 entity 包 使用别名 -->
        <property name="typeAliasesPackage" value="ac.hurley.ssm.entity" />
        <!-- 扫描 sql 配置文件：mapper 需要的 xml 文件 -->
        <property name="mapperLocations" value="classpath:mapper/*.xml" />
    </bean>

    <!-- 4. 配置扫描 Dao 接口包，动态实现 Dao 接口，注入到 spring 容器中 -->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <!-- 注入 sqlSessionFactory -->
        <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />
        <!-- 给出需要扫描 Dao 接口包 -->
        <property name="basePackage" value="ac.hurley.ssm.dao" />
    </bean>
</beans>

配置 MySQL 数据库相关参数，读取配置文件jdbc.properties。

1
2
3
4
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/ssm?useUnicode=true&characterEncoding=utf8
jdbc.username=root
jdbc.password=password

接着配置 dao 层的 Mybatis 核心文件mybatis-config.xml。

  1. 使用自增主键
  2. 使用列别名
  3. 开启驼峰命名转换
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<!-- mybatis-config.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <!-- 配置全局属性 -->
    <settings>
        <!-- 使用 jdbc 的 getGeneratedKeys 获取数据库自增主键值 -->
        <setting name="useGeneratedKeys" value="    " />

        <!-- 使用列别名替换列名 默认：     -->
        <setting name="useColumnLabel" value="    " />

        <!-- 开启驼峰命名转换：Table{create_time} -> Entity{createTime} -->
        <setting name="mapUnderscoreToCamelCase" value="    " />
    </settings>
</configuration>

然后，是准备好 service 层的spring-service.xml文件。

  1. 扫描 service 包内的所有@Service注解
  2. 配置事务管理器，把事务管理交给 Spring 来完成
  3. 配置基于注解的声明式服务，可以直接在方法上加上@Transaction注解
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
<!-- spring-service.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"
	xmlns:context="http://www.springframework.org/schema/context"
	xmlns:tx="http://www.springframework.org/schema/tx"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
	http://www.springframework.org/schema/beans/spring-beans.xsd
	http://www.springframework.org/schema/context
	http://www.springframework.org/schema/context/spring-context.xsd
	http://www.springframework.org/schema/tx
	http://www.springframework.org/schema/tx/spring-tx.xsd">
    <!-- 扫描 service 包下所有使用注解的类型 -->
    <context:component-scan base-package="ac.hurley.ssm.service" />

    <!-- 配置事务管理器 -->
    <bean id="transactionManager"
		class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <!-- 注入数据库连接池 -->
        <property name="dataSource" ref="dataSource" />
    </bean>

    <!-- 配置基于注解的声明式事务 -->
    <tx:annotation-driven transaction-manager="transactionManager" />
</beans>

然后，是配置 web 层，新建spring-web.xml文件。

  1. 开启 SpringMVC 的注解模式，可以使用到@RequestMapping、@PathVariable、@ResponseBody等
  2. 对静态资源处理，如 js、css、图片等文件
  3. 配置 JSP，显示 ViewResolver，例如在 Controller 方法里返回一个login，那么就会返回/WEB-INF/login.jsp中
  4. 扫描 web 层里的@Controller注解
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
<!-- spring-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"
	xmlns:context="http://www.springframework.org/schema/context"
	xmlns:mvc="http://www.springframework.org/schema/mvc"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
	http://www.springframework.org/schema/beans/spring-beans.xsd
	http://www.springframework.org/schema/context
	http://www.springframework.org/schema/context/spring-context.xsd
	http://www.springframework.org/schema/mvc
	http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd">
    <!-- 配置 SpringMVC -->
    <!-- 1. 开启 SpringMVC 注解模式 -->
    <!-- 简化配置：
		(1) 自动注册 DefaultAnootationHandlerMapping,AnotationMethodHandlerAdapter
		(2) 提供一些列：数据绑定，数字和日期的 format @NumberFormat, @DateTimeFormat, xml,json 默认读写支持
	-->
    <mvc:annotation-driven />

    <!-- 2. 静态资源默认 servlet 配置
		(1) 加入对静态资源的处理：js,gif,png
		(2) 允许使用"/"做整体映射
	 -->
     <mvc:default-servlet-handler/>

     <!-- 3. 配置 jsp 显示 ViewResolver -->
     <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
     	<property name="viewClass" value="org.springframework.web.servlet.view.JstlView" />
     	<property name="prefix" value="/WEB-INF/jsp/" />
     	<property name="suffix" value=".jsp" />
     </bean>

     <!-- 4. 扫描 web 相关的 bean -->
     <context:component-scan base-package="ac.hurley.ssm.web" />
</beans>


最后就是修改web.xml文件，它位于 webapp 的 WEB-INF 包下。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
<!-- web.xml -->
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
                      http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
	version="3.1" metadata-complete="    ">
    <!-- 如果是用 mvn 命令生成的 xml，需要修改 servlet 版本为3.1 -->
    <!-- 配置 DispatcherServlet -->
    <servlet>
        <servlet-name>seckill-dispatcher</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!-- 配置 springMVC 需要加载的配置文件
			spring-dao.xml,spring-service.xml,spring-web.xml
			Mybatis - > spring -> springmvc
		 -->
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:spring/spring-*.xml</param-value>
        </init-param>
    </servlet>
    <servlet-mapping>
        <servlet-name>seckill-dispatcher</servlet-name>
        <!-- 默认匹配所有的请求 -->
        <url-pattern>/</url-pattern>
    </servlet-mapping>
</web-app>

因为我们在项目中会经常用到日志，所以还需要配置日志文件，在 resources 包里新建logback.xml文件，给出的日志输出格式也是最基本的控制台输出。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<!-- logback.xml -->

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="    ">
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!-- encoders are by default assigned the type ch.qos.logback.classic.encoder.PatternLayoutEncoder -->
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="debug">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

最后的配置文件结构图如下所示：