整体框架

pom.xml
<?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.stdu</groupId>
<artifactId>springmvc_ssm</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>war</packaging>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.2.10.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>5.2.10.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-test</artifactId>
<version>5.2.10.RELEASE</version>
</dependency>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
<version>1.3.0</version>
</dependency>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.5</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>5.2.10.RELEASE</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.2.8</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.25</version>
</dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>3.1.0</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.9.0</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.tomcat.maven</groupId>
<artifactId>tomcat7-maven-plugin</artifactId>
<version>2.2</version>
<configuration>
<path>/</path>
</configuration>
</plugin>
</plugins>
</build>
</project>
JdbcConfig
package com.stdu.config;
import com.alibaba.druid.pool.DruidDataSource;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;
import org.springframework.transaction.PlatformTransactionManager;
import javax.sql.DataSource;
public class JdbcConfig {
@Value("${jdbc.driver}")
private String driver;
@Value("${jdbc.url}")
private String url;
@Value("${jdbc.username}")
private String username;
@Value("${jdbc.password}")
private String password;
/**
* 创建数据源实例
*
* 该方法使用Druid数据源组件来创建一个配置好的数据源实例
* Druid是一个高性能的数据库连接池,它能够提供数据库连接的配置、获取和管理等功能
*
* @return DataSource 返回一个配置好的数据源实例
*/
@Bean
public DataSource createDataSource(){
// 创建一个Druid数据源实例
DruidDataSource dataSource = new DruidDataSource();
// 设置数据库驱动类名
dataSource.setDriverClassName(driver);
// 设置数据库连接URL
dataSource.setUrl(url);
// 设置数据库用户名
dataSource.setUsername(username);
// 设置数据库密码
dataSource.setPassword(password);
// 返回配置好的Druid数据源实例
return dataSource;
}
@Bean
public PlatformTransactionManager createTransactionManager(DataSource dataSource){
DataSourceTransactionManager transactionManager = new DataSourceTransactionManager();
transactionManager.setDataSource(dataSource);
return transactionManager;
}
}
MybatisConfig
package com.stdu.config;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.mapper.MapperScannerConfigurer;
import org.springframework.context.annotation.Bean;
import javax.sql.DataSource;
/**
* Mybatis配置类,用于创建MyBatis相关的Spring配置组件。
*/
public class MybatisConfig {
/**
* 创建SqlSessionFactoryBean实例
*
* 该方法用于初始化并返回一个SqlSessionFactoryBean实例,该实例负责创建SqlSession。
* SqlSessionFactoryBean需要配置数据源和类型别名包路径。
*
* @param dataSource 数据源实例,用于数据库连接
* @return SqlSessionFactoryBean 配置好的SqlSessionFactoryBean实例
*/
@Bean
public SqlSessionFactoryBean createSqlSessionFactoryBean(DataSource dataSource) {
// 初始化SqlSessionFactoryBean
SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
// 设置数据源
sqlSessionFactoryBean.setDataSource(dataSource);
// 设置实体类所在的包路径,以便自动扫描并注册别名
sqlSessionFactoryBean.setTypeAliasesPackage("com.stdu.domain");
// 返回配置好的SqlSessionFactoryBean实例
return sqlSessionFactoryBean;
}
/**
* 创建MapperScannerConfigurer实例
*
* 该方法用于初始化并返回一个MapperScannerConfigurer实例,该实例负责扫描指定包下的所有Mapper接口,
* 并将它们注册为Spring的Bean。
*
* @return MapperScannerConfigurer 配置好的MapperScannerConfigurer实例
*/
@Bean
public MapperScannerConfigurer createMapperScannerConfigurer() {
// 初始化MapperScannerConfigurer
MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
// 设置基础包路径,用于扫描Mapper接口
mapperScannerConfigurer.setBasePackage("com.stdu.dao");
// 返回配置好的MapperScannerConfigurer实例
return mapperScannerConfigurer;
}
}
ServletConfig
package com.stdu.config;
import org.springframework.web.filter.CharacterEncodingFilter;
import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;
import javax.servlet.Filter;
/**
* Servlet配置类,用于初始化Spring MVC的DispatcherServlet和相关过滤器。
* 该类继承自AbstractAnnotationConfigDispatcherServletInitializer,以简化Spring MVC的配置。
*/
public class ServletConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
/**
* 获取根配置类
*
* 该方法返回Spring应用上下文的根配置类,通常包含全局的Bean定义和配置。
*
* @return Class<?>[] 根配置类数组
*/
@Override
protected Class<?>[] getRootConfigClasses() {
return new Class[]{SpringConfig.class};
}
/**
* 获取Servlet配置类
*
* 该方法返回Spring MVC的配置类,用于配置DispatcherServlet相关的Bean。
*
* @return Class<?>[] Servlet配置类数组
*/
@Override
protected Class<?>[] getServletConfigClasses() {
return new Class[]{SpringMvcConfig.class};
}
/**
* 获取Servlet映射路径
*
* 该方法返回DispatcherServlet的映射路径,指定其拦截的URL模式。
*
* @return String[] 映射路径数组
*/
@Override
protected String[] getServletMappings() {
return new String[]{"/"};
}
/**
* 获取Servlet过滤器
*
* 该方法返回一组Servlet过滤器,这些过滤器会在请求到达DispatcherServlet之前处理请求。
* 这里配置了一个字符编码过滤器,确保所有请求都使用UTF-8编码。
*
* @return Filter[] 过滤器数组
*/
@Override
protected Filter[] getServletFilters() {
// 创建字符编码过滤器,并设置编码为UTF-8
CharacterEncodingFilter characterEncodingFilter = new CharacterEncodingFilter();
characterEncodingFilter.setEncoding("UTF-8");
// 返回配置好的过滤器数组
return new Filter[]{characterEncodingFilter};
}
}
SpringConfig
package com.stdu.config;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
import org.springframework.transaction.annotation.EnableTransactionManagement;
@Configuration
@ComponentScan({"com.stdu.service","com.stdu.dao"})
@PropertySource("classpath:jdbc.properties")
@Import({JdbcConfig.class, MybatisConfig.class})
@EnableTransactionManagement
public class SpringConfig {
}
SpringMvcConfig
package com.stdu.config;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
@Configuration
@ComponentScan({"com.stdu.controller","com.stdu.config"})
@EnableWebMvc
public class SpringMvcConfig {
}
SpringMvcSupport
package com.stdu.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
@Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {
////设置静态资源访问过滤,当前类需要设置为配置类,并被扫描加载
@Override
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
//当访问/pages/????时候,从/pages目录下查找内容
registry.addResourceHandler("/pages/**").addResourceLocations("/pages/");
registry.addResourceHandler("/js/**").addResourceLocations("/js/");
registry.addResourceHandler("/css/**").addResourceLocations("/css/");
registry.addResourceHandler("/plugins/**").addResourceLocations("/plugins/");
}
}
jdbc.properties
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/lxy?useSSL=false
jdbc.username=root
jdbc.password=123456
Result&Code
package com.stdu.controller;
public class Code {
public static final Integer SAVE_OK = 20011;
public static final Integer DELETE_OK = 20021;
public static final Integer UPDATE_OK = 20031;
public static final Integer GET_OK = 20041;
public static final Integer SAVE_ERROR = 20010;
public static final Integer DELETE_ERROR = 20020;
public static final Integer UPDATE_ERROR = 20030;
public static final Integer GET_ERROR = 20040;
public static final Integer SYSTEM_UNKNOW_EXCEPTION = 50001;
}
package com.stdu.controller;
public class Result {
private Object data;
private Integer code;
private String msg;
public Result() {
}
public Result(Object data, Integer code, String msg) {
this.data = data;
this.code = code;
this.msg = msg;
}
public Result(Object data, Integer code){
this.data = data;
this.code = code;
}
/**
* 获取
* @return data
*/
public Object getData() {
return data;
}
/**
* 设置
* @param data
*/
public void setData(Object data) {
this.data = data;
}
/**
* 获取
* @return code
*/
public Integer getCode() {
return code;
}
/**
* 设置
* @param code
*/
public void setCode(Integer code) {
this.code = code;
}
/**
* 获取
* @return msg
*/
public String getMsg() {
return msg;
}
/**
* 设置
* @param msg
*/
public void setMsg(String msg) {
this.msg = msg;
}
public String toString() {
return "Result{data = " + data + ", code = " + code + ", msg = " + msg + "}";
}
}
ProjectExceptionAdvice
package com.stdu.controller;
import com.stdu.exception.BusinessException;
import com.stdu.exception.SystemException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
//@RestControllerAdvice用于标识当前类为REST风格对应的异常处理器
@RestControllerAdvice
public class ProjectExceptionAdvice {
//@ExceptionHandler用于设置当前处理器类对应的异常类型
@ExceptionHandler(SystemException.class)
public Result doSystemException(SystemException ex){
//记录日志
//发送消息给运维
//发送邮件给开发人员,ex对象发送给开发人员
return new Result(ex.getCode(),null,ex.getMessage());
}
@ExceptionHandler(BusinessException.class)
public Result doBusinessException(BusinessException ex){
return new Result(ex.getCode(),null,ex.getMessage());
}
//除了自定义的异常处理器,保留对Exception类型的异常处理,用于处理非预期的异常
@ExceptionHandler(Exception.class)
public Result doOtherException(Exception ex){
//记录日志
//发送消息给运维
//发送邮件给开发人员,ex对象发送给开发人员
return new Result(Code.SYSTEM_UNKNOW_EXCEPTION,null,"系统繁忙,请稍后再试!");
}
}
BusinessException & SystemException
package com.stdu.exception;
//自定义异常处理器,用于封装异常信息,对异常进行分类
public class BusinessException extends RuntimeException{
private Integer code;
public Integer getCode() {
return code;
}
public void setCode(Integer code) {
this.code = code;
}
public BusinessException(Integer code, String message) {
super(message);
this.code = code;
}
public BusinessException(Integer code, String message, Throwable cause) {
super(message, cause);
this.code = code;
}
}
package com.stdu.exception;
//自定义异常处理器,用于封装异常信息,对异常进行分类
public class SystemException extends RuntimeException{
private Integer code;
public Integer getCode() {
return code;
}
public void setCode(Integer code) {
this.code = code;
}
public SystemException(Integer code, String message) {
super(message);
this.code = code;
}
public SystemException(Integer code, String message, Throwable cause) {
super(message, cause);
this.code = code;
}
}