Spring-SSM整合

零、本文纲要

  • 一、SSM整合基础
  1. 创建工程
  2. SSM整合
  3. 功能模块
  4. 项目目录结构
  • 二、详细代码
  1. 基础依赖pom.xml配置
  2. Spring配置类
  3. JDBC配置文件&配置类
  4. MyBatis配置类
  5. SpringMVC配置类
  6. SpringMVC自定义配置
  7. Web项目入口配置类
  • 三、统一结果类
  1. 表现层与前端数据传输协议
  2. domain、dao、service、controller
  • 四、统一异常处理
  1. 常见异常的种类及出现异常的原因
  2. 异常处理器
  3. @RestControllerAdvice注解
  4. @ExceptionHandler注解
  5. 异常解决方案
  • 五、拦截器
  1. 拦截器和过滤器之间的区别
  2. 拦截器使用

一、SSM整合基础

1. 创建工程

2. SSM整合

  • 2.1 Spring

SpringConfig

  • 2.2 MyBatis

MyBatisConfig
JdbcConfig
jdbc.properties

  • 2.3 SpringMVC

ServletConfig
SpringMvcConfig
SpringMvcSupport

3. 功能模块

  • 3.1 表与实体类

  • 3.2 dao(接口 + 自动代理)

  • 3.3 service(接口 + 实现类)

业务层接口测试(整合JUnit)

  • 3.4 controller

表现层接口测试(PostMan)

4. 项目目录结构

|-- java
|   `-- com
|       `-- stone
|           |-- config
|           |   |-- JdbcConfig # JDBC配置:DataSource(数据源)、PlatformTransactionManager(事务管理)
|           |   |-- MyBatisConfig # MyBatis配置:SqlSessionFactoryBean、MapperScannerConfigurer
|           |   |-- ServletConfig # 配置父子容器、设置管理映射路径、Filter
|           |   |-- SpringConfig # 父容器配置:@EnableTransactionManagement等
|           |   |-- SpringMvcConfig # 子容器配置:@EnableWebMvc等
|           |   `-- SpringMvcSupport # SpringMVC支持:静态资源映射、拦截器Interceptor
|           |-- controller
|           |   |-- BookController
|           |   |-- Code # 返回码
|           |   |-- ProjectExceptionAdvice # 统一异常处理:@RestControllerAdvice、@ExceptionHandler
|           |   |-- ProjectInterceptor # 拦截器:实现HandlerInterceptor接口
|           |   `-- Result
|           |-- dao
|           |   `-- BookDao
|           |-- domain
|           |   `-- Book
|           |-- exception
|           |   |-- BusinessException # 自定义异常类:义务异常
|           |   `-- SystemException # 自定义异常类:系统异常
|           `-- service
|               |-- BookService
|               `-- impl
|                   `-- BookServiceImpl
`-- resources
    |-- jdbc.properties # JDBC配置

二、详细代码

1. 基础依赖pom.xml配置

① Servlet3.0:javax.servlet-api

② Spring、SpringMVC、JSON:spring-webmvc、jackson-databind

③ 数据库操作(事务):spring-jdbc、mybatis、mybatis-spring、mysql-connector-java、druid

④ 测试:spring-test、junit

<!--spring_web_mvc-->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>5.2.10.RELEASE</version>
</dependency>
<!--spring_jdbc-->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-jdbc</artifactId>
    <version>5.2.10.RELEASE</version>
</dependency>
<!--spring_test-->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-test</artifactId>
    <version>5.2.10.RELEASE</version>
</dependency>
<!--junit-->
<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.13.1</version>
    <scope>test</scope>
</dependency>
<!--mybatis-->
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.9</version>
</dependency>
<!--mybatis_spring-->
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis-spring</artifactId>
    <version>2.0.7</version>
</dependency>
<!--druid_datasource-->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.2.8</version>
</dependency>
<!--mysql_connector-->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.26</version>
</dependency>
<!--jackson-->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.13.1</version>
</dependency>
<!--servlet-->
<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>3.1.0</version>
    <scope>provided</scope>
</dependency>

2. Spring配置类

@Configuration
@ComponentScan({"com.stone.service", "com.stone.dao"})
@PropertySource({"classpath:jdbc.properties"})
@Import({JdbcConfig.class, MyBatisConfig.class})
@EnableTransactionManagement // 开启事务管理的支持
public class SpringConfig {
}

3. JDBC配置文件&配置类

  • ① jdbc.properties
jdbc.driver=com.mysql.cj.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/ssm_db
jdbc.username=root
jdbc.password=root
  • ② JdbcConfig
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;

    @Bean
    public DataSource dataSource(){ // 数据源
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(driver);
        dataSource.setUrl(url);
        dataSource.setUsername(username);
        dataSource.setPassword(password);
        return dataSource;
    }

    @Bean
    public PlatformTransactionManager transactionManager(DataSource dataSource){
        DataSourceTransactionManager transactionManager = new DataSourceTransactionManager();
        transactionManager.setDataSource(dataSource);
        return transactionManager; // 事务管理
    }
}

4. MyBatis配置类

public class MyBatisConfig {
    @Bean
    public SqlSessionFactoryBean sqlSessionFactory(DataSource dataSource){
        SqlSessionFactoryBean sqlSessionFactory = new SqlSessionFactoryBean();
        sqlSessionFactory.setDataSource(dataSource); // 设置数据源
        sqlSessionFactory.setTypeAliasesPackage("com.stone.domain"); // 别名扫描
        return sqlSessionFactory;
    }

    @Bean
    public MapperScannerConfigurer mapperScannerConfigurer(){
        MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
        mapperScannerConfigurer.setBasePackage("com.stone.dao"); // 映射代理
        return mapperScannerConfigurer;
    }
}

5. SpringMVC配置类

@Configuration
@ComponentScan({"com.stone.controller", "com.stone.config"})
@EnableWebMvc // 启用MVC核心组件、支持自定义配置
public class SpringMvcConfig {
}

6. SpringMVC自定义配置

@Configuration
public class SpringMvcSupport  extends WebMvcConfigurationSupport {

    @Autowired
    private ProjectInterceptor projectInterceptor;

    @Override // 静态资源映射
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/pages/**").addResourceLocations("/pages/");
        registry.addResourceHandler("/css/**").addResourceLocations("/css/");
        registry.addResourceHandler("/js/**").addResourceLocations("/js/");
        registry.addResourceHandler("/plugins/**").addResourceLocations("/plugins/");
    }

    @Override // 拦截器
    protected void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(projectInterceptor).addPathPatterns("/books" );
    }
}

7. Web项目入口配置类

public class ServletConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
    @Override
    protected Class<?>[] getRootConfigClasses() {
        return new Class[]{SpringConfig.class}; // Spring配置
    }

    @Override
    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{SpringMvcConfig.class}; // SpringMVC配置
    }

    @Override
    protected String[] getServletMappings() {
        return new String[]{"/"}; // 配置受SpringMVC管理的请求路径
    }

    @Override // 处理POST请求中文乱码问题
    protected Filter[] getServletFilters() {
        CharacterEncodingFilter filter = new CharacterEncodingFilter();
        filter.setEncoding("UTF-8");
        return new Filter[]{filter};
    }
}

三、统一结果类

1. 表现层与前端数据传输协议

将返回结果的数据进行统一,统一数据返回结果类,如下:

public class Result{
    private Object data;
    private Integer code;
    private String msg;
    ...此处省略get/set/constructor...
}

状态码,比如末尾1成功,0失败,如下:

//状态码
public class Code {
    public static final Integer SAVE_OK = 20011;
    public static final Integer SAVE_ERR = 20010;
    ... ...
}

2. domain、dao、service、controller

  • ① Book实体类
public class Book {
    private Integer id;
    private String type;
    private String name;
    private String description;
    ... ...    
}
  • ② BookDao
public interface BookDao {

    //@Insert("insert into tbl_book values(null,#{type},#{name},#{description})")
    @Insert("insert into tbl_book (type,name,description) values(#{type},#{name},#{description})")
    public int save(Book book);

    @Update("update tbl_book set type = #{type}, name = #{name}, description = #{description} where id = #{id}")
    public int update(Book book);

    @Delete("delete from tbl_book where id = #{id}")
    public int delete(Integer id);

    @Select("select * from tbl_book where id = #{id}")
    public Book getById(Integer id);

    @Select("select * from tbl_book")
    public List<Book> getAll();
}
  • ③ Service及实现类
public interface BookService {
    public boolean save(Book book);
    public boolean update(Book book);
    public boolean delete(Integer id);
    public Book getById(Integer id);
    public List<Book> getAll();
}

@Service
public class BookServiceImpl implements BookService {

    @Autowired
    private BookDao bookDao;

    @Override
    public boolean save(Book book) {
        String bookName = book.getName();
        if (bookName.length() > 20){
            throw new BusinessException(Code.BUSINESS_ERR, "书名过长,不合法!");
        }
        return bookDao.save(book) > 0;
    }

    @Override
    public boolean update(Book book) {
        return bookDao.update(book) > 0;
    }

    @Override
    public boolean delete(Integer id) {
        return bookDao.delete(id) > 0;
    }

    @Override
    public Book getById(Integer id) {
        return bookDao.getById(id);
    }

    @Override
    public List<Book> getAll() {
        return bookDao.getAll();
    }
}
  • ④ Controller表现层

可以看到表现层统一使用Result作为返回结果,如下:

@RestController
@RequestMapping("/books")
public class BookController {

    @Autowired
    private BookService bookService;

    @PostMapping
    public Result save(@RequestBody Book book) {
        boolean flag = bookService.save(book);
        return new Result(flag ? Code.SAVE_OK:Code.SAVE_ERR,flag);
    }

    @PutMapping
    public Result update(@RequestBody Book book) {
        boolean flag = bookService.update(book);
        return new Result(flag ? Code.UPDATE_OK:Code.UPDATE_ERR,flag);
    }

    @DeleteMapping("/{id}")
    public Result delete(@PathVariable Integer id) {
        boolean flag = bookService.delete(id);
        return new Result(flag ? Code.DELETE_OK:Code.DELETE_ERR,flag);
    }

    @GetMapping("/{id}")
    public Result getById(@PathVariable Integer id) {
        Book book = bookService.getById(id);
        Integer code = book != null ? Code.GET_OK : Code.GET_ERR;
        String msg = book != null ? "" : "数据查询失败,请重试!";
        return new Result(code,book,msg);
    }

    @GetMapping
    public Result getAll() {
        List<Book> bookList = bookService.getAll();
        Integer code = bookList != null ? Code.GET_OK : Code.GET_ERR;
        String msg = bookList != null ? "" : "数据查询失败,请重试!";
        return new Result(code,bookList,msg);
    }
}

四、统一异常处理

1. 常见异常的种类及出现异常的原因

  • ① 框架内部抛出的异常

因使用不合规导致;

  • ② 数据层抛出的异常

因外部服务器故障导致(例如:服务器访问超时);

  • ③ 业务层抛出的异常

因业务逻辑书写错误导致(例如:遍历业务书写操作错误,导致索引异常等);

  • ④ 表现层抛出的异常

因数据收集、校验等规则导致(例如:不匹配的数据类型间导致异常);

  • ⑤ 工具类抛出的异常

因工具类书写不严谨不够健壮导致(例如:必要释放的连接长期未释放等)。

2. 异常处理器

  • ① 自定义异常类

Ⅰ BusinessException用于统一处理业务异常,如下:

//自定义异常处理器,用于封装异常信息,对异常进行分类
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;
    }
}

Ⅱ SystemException用于统一处理系统异常,如下:

//自定义异常处理器,用于封装异常信息,对异常进行分类
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;
    }
}
  • ② 统一异常处理

对不同的异常做不同的处理,如下:

@RestControllerAdvice
public class ProjectExceptionAdvice {
    //@ExceptionHandler用于设置当前处理器类对应的异常类型
    @ExceptionHandler(BusinessException.class)
    public Result doBusinessException(BusinessException ex){
        return new Result(ex.getCode(),null,ex.getMessage());
    }

    @ExceptionHandler(SystemException.class)
    public Result doSystemException(SystemException ex){
        //记录日志
        //发送消息给运维
        //发送邮件给开发人员,ex对象发送给开发人员
        return new Result(ex.getCode(),null,ex.getMessage());
    }

    @ExceptionHandler(Exception.class)
    public Result doExceptionHandle(Exception ex){
        return new Result(Code.SYSTEM_UNKNOW_ERR,null,"系统繁忙,请稍后再试!");
    }
}

3. @RestControllerAdvice注解

在类上使用,为Rest风格开发的控制器类做增强。

4. @ExceptionHandler注解

在方法上使用,设置指定异常的处理方案,功能等同于控制器方法。

出现异常后终止原始控制器执行,并转入当前方法执行。

5. 异常解决方案

  • ① 业务异常(BusinessException)

发送对应消息传递给用户,提醒规范操作。

如:用户名已存在密码格式不正确等。

  • ② 系统异常(SystemException)

Ⅰ 发送固定消息传递给用户,安抚用户;

如:系统繁忙,请稍后再试系统正在维护升级,请稍后再试等。

Ⅱ 发送特定消息给运维人员,提醒维护;

如:发送短信邮箱或者是公司内部通信软件等。

Ⅲ 记录日志。

  • ③ 其他异常(Exception)

此类异常一般是前期开发没考虑到,后续需要考虑归入上两种异常。

Ⅰ 发送固定消息传递给用户,安抚用户;

Ⅱ 发送特定消息给运维人员,提醒维护(纳入预期范围内);

Ⅲ 记录日志。

五、拦截器

1. 拦截器和过滤器之间的区别

  • 归属不同:Filter属于Servlet技术,Interceptor属于SpringMVC技术
  • 拦截内容不同:Filter对所有访问进行增强,Interceptor仅针对SpringMVC的访问进行增强

2. 拦截器使用

  • ① 编写拦截器类

此处我们模拟了header验证的逻辑,代码如下:

@Component
//定义拦截器类,实现HandlerInterceptor接口
//注意当前类必须受Spring容器控制
public class ProjectInterceptor implements HandlerInterceptor {
    @Override
    //原始方法调用前执行的内容
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        String authorization = request.getHeader("authorization");
        if (!authorization.equals("user_token")){
            // 设置响应状态码
            response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
            // 设置响应格式
            response.setContentType("application/json; charset=utf-8");
            // 设置前后端协议的响应结果类
            Result result = new Result(SYSTEM_UNAUTHORIZED, null, "没有访问权限!");
            PrintWriter writer = response.getWriter();
            writer.write(JSONUtils.toJSONString(result));
            writer.flush();
            writer.close();
            return false;
        }
        return true;
    }

    @Override
    //原始方法调用后执行的内容
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
    }

    @Override
    //原始方法调用完成后执行的内容
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
    }
}

注意:由于我们统一了结果类,所以并不是说拦截器拦截了访问就什么内容也不给前端反馈。而是使用response将我们的Result结果类写回。

  • ② 拦截器配置

Ⅰ 在SpringMvcSupport类中我们重写了addInterceptors方法,配置了拦截器。

Ⅱ 也可以通过实现WebMvcConfigurer接口,进而配置拦截器,如下:

@Configuration
@ComponentScan({"com.itheima.controller"})
@EnableWebMvc
//实现WebMvcConfigurer接口可以简化开发,但具有一定的侵入性
public class SpringMvcConfig implements WebMvcConfigurer {
    @Autowired
    private ProjectInterceptor projectInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //配置多拦截器
        registry.addInterceptor(projectInterceptor).addPathPatterns("/books","/books/*");
    }
}

此种配置会使得自定义配置与统一的配置类耦合变高,所以实际使用中需要衡量实现

WebMvcConfigurer接口,还是继承WebMvcConfigurationSupport抽象类。

六、结尾

以上即为Spring-SSM整合的全部内容,感谢阅读。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,686评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,668评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,160评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,736评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,847评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,043评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,129评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,872评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,318评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,645评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,777评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,470评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,126评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,861评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,095评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,589评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,687评论 2 351

推荐阅读更多精彩内容