一、搭建框架
1、首先创建下面的目录结构
2、添加相关依赖:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><groupId>com.ssm.crm</groupId><artifactId>crm</artifactId><version>1.0-SNAPSHOT</version><packaging>war</packaging><properties><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding><maven.compiler.source>1.7</maven.compiler.source><maven.compiler.target>1.7</maven.compiler.target></properties><dependencies><!-- MySQL数据库连接驱动 --><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>8.0.21</version></dependency><!-- JDBC数据源连接池 --><dependency><groupId>com.alibaba</groupId><artifactId>druid</artifactId><version>1.1.1</version></dependency><!-- MyBatis框架依赖 --><dependency><groupId>org.mybatis</groupId><artifactId>mybatis</artifactId><version>3.4.1</version></dependency><!-- Spring框架依赖的JAR配置 --><dependency><groupId>org.springframework</groupId><artifactId>spring-context</artifactId><version>4.3.9.RELEASE</version></dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-aop</artifactId><version>4.3.9.RELEASE</version></dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-core</artifactId><version>4.3.9.RELEASE</version></dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-beans</artifactId><version>4.3.9.RELEASE</version></dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-jdbc</artifactId><version>4.3.9.RELEASE</version></dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-tx</artifactId><version>4.3.9.RELEASE</version></dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-web</artifactId><version>4.3.9.RELEASE</version></dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-webmvc</artifactId><version>4.3.9.RELEASE</version></dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-oxm</artifactId><version>4.3.9.RELEASE</version></dependency><!-- Spring AOP支持--><dependency><groupId>org.aspectj</groupId><artifactId>aspectjweaver</artifactId><version>1.8.9</version></dependency><!-- MyBatis与Spring整合依赖 --><dependency><groupId>org.mybatis</groupId><artifactId>mybatis-spring</artifactId><version>1.3.0</version></dependency><!-- servlet及jstl标签库依赖的JAR配置 --><dependency><groupId>javax.servlet</groupId><artifactId>javax.servlet-api</artifactId><version>3.1.0</version></dependency><dependency><groupId>javax.servlet.jsp.jstl</groupId><artifactId>jstl-api</artifactId><version>1.2</version></dependency><dependency><groupId>org.apache.taglibs</groupId><artifactId>taglibs-standard-spec</artifactId><version>1.2.1</version></dependency><dependency><groupId>org.apache.taglibs</groupId><artifactId>taglibs-standard-impl</artifactId><version>1.2.1</version></dependency><!-- 加载jackson插件依赖 --><dependency><groupId>com.fasterxml.jackson.core</groupId><artifactId>jackson-core</artifactId><version>2.7.3</version></dependency><dependency><groupId>com.fasterxml.jackson.core</groupId><artifactId>jackson-databind</artifactId><version>2.7.3</version></dependency><dependency><groupId>com.fasterxml.jackson.core</groupId><artifactId>jackson-annotations</artifactId><version>2.7.3</version></dependency><dependency><groupId>com.fasterxml.jackson.module</groupId><artifactId>jackson-module-jaxb-annotations</artifactId><version>2.2.3</version></dependency><!--poi依赖--><dependency><groupId>org.apache.poi</groupId><artifactId>poi</artifactId><version>3.15</version></dependency><!-- 文件上传 --><dependency><groupId>commons-fileupload</groupId><artifactId>commons-fileupload</artifactId><version>1.3.1</version></dependency><!-- Log4j2依赖的JAR配置 --><dependency><groupId>org.apache.logging.log4j</groupId><artifactId>log4j-api</artifactId><version>2.3</version></dependency><dependency><groupId>org.apache.logging.log4j</groupId><artifactId>log4j-core</artifactId><version>2.3</version></dependency><dependency><groupId>org.apache.logging.log4j</groupId><artifactId>log4j-jcl</artifactId><version>2.3</version></dependency><!-- google java lib --><dependency><groupId>com.google.guava</groupId><artifactId>guava</artifactId><version>17.0</version></dependency><dependency><groupId>com.google.guava</groupId><artifactId>guava</artifactId><version>17.0</version></dependency><dependency><groupId>org.apache.commons</groupId><artifactId>commons-lang3</artifactId><version>3.3.2</version></dependency><!-- xstream xml --><dependency><groupId>com.thoughtworks.xstream</groupId><artifactId>xstream</artifactId><version>1.4.7</version></dependency></dependencies><build><plugins><!-- tomcat7插件 --><plugin><groupId>org.apache.tomcat.maven</groupId><artifactId>tomcat7-maven-plugin</artifactId><version>2.1</version><configuration><port>8080</port><path>/</path></configuration></plugin><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-compiler-plugin</artifactId><configuration><source>7</source><target>7</target></configuration></plugin></plugins></build></project>
3、springmvc.xml springmvc配置文件:
<?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"xmlns:aop="http://www.springframework.org/schema/aop"xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.1.xsdhttp://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.1.xsdhttp://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.1.xsdhttp://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.1.xsd"><!-- 启用注解驱动 --><!-- 用于启用注解驱动。它支持 @RequestMapping、@Controller 等注解的使用,让 Spring MVC 自动识别注解的控制器并处理映射关系 --><mvc:annotation-driven/><!-- 配置组件扫描 --><!-- 扫描controller包下面的所有的类,注入到springmvc中也可以使用 <context:include-filter /> 选择过滤只包含@controller注解的类 --><context:component-scan base-package="com.ssm.crm.controller"/><!-- 配置视图解析器 --><!-- InternalResourceViewResolver 是 Spring MVC 内置的视图解析器之一。配置 prefix 和 suffix 后,Spring MVC 会将控制器返回的视图名称拼接成文件路径。例如,如果控制器返回 home,则解析器会将其映射到 /WEB-INF/views/home.jsp。--><bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"><property name="prefix" value="/WEB-INF/views/"/><property name="suffix" value=".jsp"/></bean><!-- 配置静态资源处理 --><!-- mvc:resources 用于指定静态资源的访问路径和物理路径。这里的配置表示将 /static/** 路径下的请求映射到项目中的 /static/ 目录。mapping="/static/**":指定了静态资源的 URL 映射路径。当客户端访问以 /static/ 开头的 URL 时,Spring MVC 会将这些请求映射到实际的静态资源路径中去。这意味着所有匹配 /static/** 的请求将直接从指定的资源目录中获取静态文件,而不是通过 Spring MVC 控制器。location="/static/":定义了静态资源在项目中的存储位置。这里的 /static/ 表示资源目录在项目的根目录下,所有静态文件都应该放在 static 文件夹中。例如,/static/images/logo.png 可以通过 URL http://yourdomain/static/images/logo.png 来访问。cache-period="31536000":设置了缓存的有效期,以秒为单位。31536000 秒相当于一年(365 天),这意味着客户端将缓存这些静态资源一年,从而减少服务器的负载和带宽使用。配置了缓存有效期后,浏览器会根据缓存过期时间来判断是否需要重新加载资源文件,适合那些不经常更改的静态文件,如图片、CSS、JS 文件等。--><mvc:resources mapping="/static/**" location="/static/" cache-period="31536000"/><!-- 配置文件上传解析器 --><!-- CommonsMultipartResolver 支持文件上传操作,它将文件上传的请求解析为 MultipartFile,方便控制器处理上传文件。--><!-- maxUploadSize 说明:设置允许上传的最大文件大小,以字节为单位。${web.maxUploadSize}:从配置文件中获取 web.maxUploadSize 的值。作用:如果上传文件的大小超过此限制,将抛出 MaxUploadSizeExceededException 异常。maxInMemorySize 说明:定义文件上传时允许写入内存的最大值,以字节为单位。默认值 10240(10KB):不设置时,默认值为 10KB,表示上传文件小于此值时直接存储在内存中,而不生成临时文件。value="0":设置为 0 意味着所有文件上传内容将直接写入临时文件,而不保存在内存中。适用于希望减少内存消耗的大文件上传情况。--><bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver"><property name="maxUploadSize" value="${web.maxUploadSize}" /><!-- 设置文件上传是允许写到内存中的最大值 ,以字节为单位默认:10240=10K--><!-- 经测试,上传文件小于此值时则不会生成临时文件 --><property name="maxInMemorySize" value="0" /></bean><!-- 配置消息转换器 --><!-- 通过 <mvc:message-converters> 配置消息转换器,Spring 会自动将返回的 Java 对象转换为客户端需要的格式(如 JSON 或 XML)。--><!-- StringHttpMessageConverter 用于处理字符串类型的消息。它可以将 Java 字符串转换为 HTTP 响应的字符串内容。在此配置中,通过 <constructor-arg value="UTF-8" /> 设置了字符串转换时的字符编码为 UTF-8。这是常见的做法,用来确保字符编码的一致性。--><!-- MappingJackson2HttpMessageConverter 是用于处理 JSON 格式的消息转换器,它基于 Jackson 库将 Java 对象转换为 JSON 字符串,反之亦然。配置中的 supportedMediaTypes 将媒体类型设置为 application/json;charset=UTF-8,这表示此转换器只会处理 application/json 类型的响应,并且会使用 UTF-8 编码。prettyPrint 设置为 false,表示输出的 JSON 格式不会被格式化(即不会有额外的缩进或换行)。如果你希望返回的 JSON 格式更易读,可以设置为 true。通过 objectMapper 属性自定义了 Jackson 的 ObjectMapper,这里引用了 com.ssm.common.json.JsonMapper,这个类应该是你自定义的 ObjectMapper,可以用来做一些自定义的 JSON 处理(如日期格式、字段过滤等)。--><mvc:annotation-driven><mvc:message-converters register-defaults="true"><!-- 将StringHttpMessageConverter的默认编码设为UTF-8 --><bean class="org.springframework.http.converter.StringHttpMessageConverter"><constructor-arg value="UTF-8" /></bean><!-- 将Jackson2HttpMessageConverter的默认格式化输出为false --><bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter"><property name="supportedMediaTypes"><list><value>application/json;charset=UTF-8</value></list></property><property name="prettyPrint" value="false"/><property name="objectMapper"><bean class="com.ssm.common.json.JsonMapper"></bean></property></bean></mvc:message-converters></mvc:annotation-driven><!-- 配置拦截器 -->
<!-- 暂时没用到-->
<!-- <mvc:interceptors>-->
<!-- <mvc:interceptor>-->
<!-- <mvc:mapping path="/**"/>-->
<!-- <bean class="com.example.interceptor.LoginInterceptor"/>-->
<!-- </mvc:interceptor>-->
<!-- </mvc:interceptors>--><!-- 开发环境配置 dev环境指定dev配置文件 ,--><beans profile="dev"><context:property-placeholder location="classpath:configs-dev.properties"/></beans><!-- 测试环境配置 --><beans profile="prod"><context:property-placeholder location="classpath:configs-prod.properties"/></beans></beans>
4、添加 mybatis-config.xml 配置文件
MyBatis 的mybatis-config.xml
通常以如下基本结构为主:
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configurationPUBLIC "-//mybatis.org//DTD Config 3.0//EN""http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration><!-- 全局配置 --><settings><!-- 配置选项 --></settings><!-- 类型别名 --><typeAliases><!-- 定义别名 --></typeAliases><!-- 插件配置 --><plugins><!-- 配置插件 --></plugins><!-- 类型处理器 --><typeHandlers><!-- 定义自定义类型处理器 --></typeHandlers><!-- 环境配置(数据源和事务管理) --><environments default="development"><environment id="development"><transactionManager type="JDBC"/><dataSource type="POOLED"><property name="driver" value="com.mysql.cj.jdbc.Driver"/><property name="url" value="jdbc:mysql://localhost:3306/your_db"/><property name="username" value="root"/><property name="password" value="password"/></dataSource></environment></environments><!-- 映射文件 --><mappers><!-- 配置Mapper文件路径 --></mappers>
</configuration>
虽然上述配置都可以在springconfig中进行配置,但其实 datasource 数据源的配置和 mappers 映射文件的配置,通常会配置在 spring 的配置文件中。所以我们简单配置的案例如下:
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configurationPUBLIC "-//mybatis.org//DTD Config 3.0//EN""http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration><!-- 全局配置 --><settings><setting name="logImpl" value="STDOUT_LOGGING"/> <!-- 将sql日志打印到控制台 --><setting name="cacheEnabled" value="true"/> <!-- 开启二级缓存 --><setting name="lazyLoadingEnabled" value="true"/> <!-- 懒加载 --><setting name="mapUnderscoreToCamelCase" value="true"/> <!-- 自动映射数据库的下划线命名字段到Java驼峰命名属性 --></settings><!-- 类型别名 --><!-- 该配置指定了 com.ssm.crm.model 包路径。MyBatis 会扫描这个包下的所有类,并为它们创建别名。自动别名规则:MyBatis 会自动使用类名(首字母小写)作为别名。例如,com.bjpowernode.crm.model.User 类会被自动映射为 user,而 com.bjpowernode.crm.model.CustomerInfo 类会被映射为 customerInfo。在 XML 文件中,使用别名替代全限定类名会使映射文件更简洁。例如:<resultMap id="userResultMap" type="user"><id column="id" property="id"/><result column="name" property="name"/><result column="age" property="age"/></resultMap>在这里,我们用 user 替代了全限定类名 com.bjpowernode.crm.model.User,使 XML 文件更易读。--><typeAliases><package name="com.ssm.crm.model"/></typeAliases></configuration>
<typeHandlers> 暂时没用到先不进行配置。
<dataSource> 数据源配置 跟 <mappers> 映射文件配置,我们放到spring的配置文件中去。
5、spring.xml spring配置文件:
Bean 配置:
Spring 的核心功能之一是通过 IoC(控制反转)容器来管理对象。spring.xml
中定义 Bean 是最常见的操作。
<bean id="myBean" class="com.example.MyClass"><property name="propertyName" value="propertyValue"/>
</bean>
id
: Bean 的标识符,其他组件可以通过这个 ID 获取该 Bean。class
: Bean 的实现类。property
: 通过属性注入(setter 注入)将数据提供给 Bean 的成员变量。
<?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:jdbc="http://www.springframework.org/schema/jdbc"xmlns:jee="http://www.springframework.org/schema/jee" xmlns:tx="http://www.springframework.org/schema/tx"xmlns:util="http://www.springframework.org/schema/util" xmlns:task="http://www.springframework.org/schema/task" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.1.xsdhttp://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.1.xsdhttp://www.springframework.org/schema/jdbc http://www.springframework.org/schema/jdbc/spring-jdbc-4.1.xsdhttp://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-4.1.xsdhttp://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.1.xsdhttp://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-4.1.xsdhttp://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-4.1.xsd"default-lazy-init="true"><!-- base-package="com.ssm.crm":指示 Spring 扫描 com.ssm.crm 包及其子包中的类,自动将符合条件的类注册为 Spring Bean。type="annotation":表示排除的条件是基于注解的。expression="org.springframework.stereotype.Controller":表示排除所有标注了 @Controller 注解的类。如果有任何类是通过 @Controller 注解标记的,它们将不会被 Spring 自动注册为 Bean。--><context:component-scan base-package="com.ssm.crm"><!-- base-package 如果多个,用“,”分隔 --><context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/></context:component-scan><!-- DecryptDruidSource:这是自定义的 Druid 数据源类,对 DruidDataSource 进行了一些定制化,加密解密数据库连接配置。为了解决配置文件中的敏感信息(如数据库密码)进行解密。 --><bean id="dataSource" class="com.ssm.common.untils.DecryptDruidSource"><!-- 数据源驱动类可不写,Druid默认会自动根据URL识别DriverClass --><property name="driverClassName" value="${jdbc.driver}" /><!-- 基本属性 url、user、password --><property name="url" value="${jdbc.url}" /><property name="username" value="${jdbc.username}" /><property name="password" value="${jdbc.password}" /><!-- 配置初始化大小、最小、最大 --><!-- initialSize:连接池的初始大小(在启动时创建的连接数)。例如,如果配置为 5,则连接池初始化时会创建 5 个数据库连接。minIdle:连接池中保持的最小空闲连接数。低于该数值时,连接池会创建新的连接以保证有足够的空闲连接。maxActive:连接池中最大连接数。超过这个数量时,新的请求将被阻塞,直到有空闲连接可用。--><property name="initialSize" value="${jdbc.pool.init}" /><property name="minIdle" value="${jdbc.pool.minIdle}" /><property name="maxActive" value="${jdbc.pool.maxActive}" /><!-- 配置获取连接等待超时的时间 如果数据库连接池中没有空闲连接,它会在 60 秒内一直尝试获取连接。 --><property name="maxWait" value="60000" /><!-- 配置间隔多久才进行一次检测,检测需要关闭的空闲连接,单位是毫秒 例如,每 60 秒检查一次池中的连接,关闭那些空闲时间过长的连接。 --><property name="timeBetweenEvictionRunsMillis" value="60000" /><!-- 配置一个连接在池中最小生存的时间,单位是毫秒 例如,连接如果空闲 5 分钟,就会被关闭。--><property name="minEvictableIdleTimeMillis" value="300000" /><!-- 用来验证数据库连接是否有效的 SQL 查询。例如,SELECT 1 或 SELECT 1 FROM DUAL(对于 Oracle)。--><property name="validationQuery" value="${jdbc.testSql}" /><!-- 是否在空闲连接时进行有效性检查。设置为 true 时,空闲连接会定期执行 validationQuery 进行检查。 --><property name="testWhileIdle" value="true" /><!-- 在每次获取连接时是否检查连接的有效性。设置为 false 表示不进行检查。--><property name="testOnBorrow" value="false" /><!-- 在每次归还连接时是否检查连接的有效性。设置为 false 表示不进行检查。--><property name="testOnReturn" value="false" /><!-- 配置监控统计拦截的filters --><!-- Druid 提供了监控功能,stat 是用于监控统计信息的一个拦截器,能够生成数据库连接池的运行时统计数据。通过它,可以查看连接池的状态、SQL 执行情况等。--><property name="filters" value="stat" /></bean><!-- 事务管理器,负责在执行事务时提交和回滚事务 --><bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager"><property name="dataSource" ref="dataSource"/></bean><!-- MyBatis begin --><bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"><property name="dataSource" ref="dataSource"/><!-- 指定 MyBatis 配置文件 --><property name="mapperLocations" value="classpath:/mappings/**/*.xml"/><!-- 指定 MyBatis 映射文件 --><property name="configLocation" value="classpath:/mybatis-config.xml"></property><!-- 配置 MyBatis 类型别名 --><property name="typeAliasesPackage" value="com.ssm.crm.model"/><!-- 这个属性用于指定 MyBatis 别名的父类类型,MyBatis 会扫描所有继承自该父类的类并注册为别名。在这个例子中,CommonModel 是所有实体类的父类,这样所有继承自 CommonModel 的类都将被自动注册为 MyBatis 的别名。--><property name="typeAliasesSuperType" value="com.ssm.common.base.CommonModel"/></bean><!-- 配置 SqlSessionTemplate --><bean id="sqlSessionTemplate" class="org.mybatis.spring.SqlSessionTemplate"><constructor-arg ref="sqlSessionFactory"/></bean><!-- 开发环境配置 dev环境指定dev配置文件 ,--><beans profile="dev"><context:property-placeholder location="classpath:configs-dev.properties"/></beans><!-- 测试环境配置 --><beans profile="prod"><context:property-placeholder location="classpath:configs-prod.properties"/></beans></beans>
6、web.xml 配置文件: