从零搭建自己的SpringBoot后台框架(一)

原文链接： https://juejin.im/post/5ad6b3c3f265da237c696ba0

项目简介

框架简介

框架为springboot+mybatis项目，支持多数据源；整合通用mapper；整合json Web Token加密；支持aop记录用户操作日志；整合代码生成插件，自动生成增删改查等基础代码；微信支付；发送邮件；图片压缩水印；支持动态定时任务；统一异常处理；请求结果的封装等；

框架结构

aop文件夹中是自定义注解用于记录用户操作日志

configurer文件夹中是一些配置文件，如mybatis分页插件的配置等

constant文件夹中是一些常量的定义，如微信支付常量，发送短信需要的一些常量等

generic文件夹中是自定义一些顶级通用接口

ret文件夹中是自定义请求结果格式和枚举请求码

startupRunner文件夹中是当服务器启动成功后执行的方法

tasks文件中为定时任务

test中CodeGenerstor为代码生产器

template中为生成代码的模板

 

一：通过idea工具构建基础框架

  1.  打开idea，左上角File→New→Project，看到如下图的页面

  2.  点击Next，配置如下图
  3.  点击Next，配置如下图，这里我们选择数据库MySQL和持久层框架MyBatis
  4.  点击Next，选择工作目录，点击Finish，开始构建

 

  5.  创建完成后，项目目录结构如下

DemoApplicttion.java为项目的启动类

application.properties为项目配置文件

pom.xml主要描述了项目的maven坐标，依赖关系，开发者需要遵循的规则，缺陷管理系统，组织和licenses，以及其他所有的项目相关因素，是项目级别的配置文件（说人话：项目所需jar包的管理）

 

二：配置数据库信息

在application.properties文件中添加如下数据库配置

spring.datasource.url=jdbc:mysql://localhost:3306/demo?useSSL=false&useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull&transformedBitIsBoolean=true&autoReconnect=true&failOverReadOnly=false
spring.datasource.username=数据库用户名
spring.datasource.password=数据库密码
spring.datasource.driverClassName=com.mysql.jdbc.Driver

三：创建数据库UserInfo表

 

 

 

 

CREATE TABLE `user_info` (
  `id` int(32) NOT NULL AUTO_INCREMENT,
  `user_name` varchar(255) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8; 

四：创建项目基本目录结构

Model

package com.example.demo.model;

import javax.persistence.Column;
import javax.persistence.Id;

/**
 * @author phubing
 * @Description:
 * @time 2019/4/18 11:55
 */
public class UserInfo {

    /**
     * 主键
     */
    @Id
    private String id;

    /**
     * 用户名
     */
    @Column(name = "user_name")
    private String userName;

    private String password;

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

}

Mapper

    
        
        
    

    
      id,user_name
    

    
        select
        
        from user_info
        where id = #{id,jdbcType=VARCHAR}
    

Dao

package com.example.demo.dao;

import com.example.demo.model.UserInfo;
import org.apache.ibatis.annotations.Param;

/**
 * @author phubing
 * @Description:
 * @time 2019/4/18 11:55
 */
public interface UserInfoMapper {

    UserInfo selectById(@Param("id") Integer id);
}

Service

package com.example.demo.service;

import com.example.demo.model.UserInfo;

/**
 * @author phubing
 * @Description:
 * @time 2019/4/18 11:55
 */
public interface UserInfoService {

    UserInfo selectById(Integer id);

}

ServiceImpl

package com.example.demo.service.impl;

import com.example.demo.dao.UserInfoMapper;
import com.example.demo.model.UserInfo;
import com.example.demo.service.UserInfoService;
import org.springframework.stereotype.Service;

import javax.annotation.Resource;

/**
 * @author phubing
 * @Description:
 * @time 2019/4/18 11:55
 */
@Service
public class UserInfoServiceImpl implements UserInfoService{

    @Resource
    private UserInfoMapper userInfoMapper;

    public UserInfo selectById(Integer id){
        return userInfoMapper.selectById(id);
    }
}

Controller

package com.example.demo.controller;

import com.example.demo.model.UserInfo;
import com.example.demo.service.UserInfoService;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;

/**
 * @author phubing
 * @Description:
 * @time 2019/4/18 11:55
 */
@RestController
@RequestMapping("userInfo")
public class UserInfoController {

    @Resource
    private UserInfoService userInfoService;

    @PostMapping("/hello")
    public String hello(){
        return "hello SpringBoot";
    }

    @PostMapping("/selectById")
    public UserInfo selectById(Integer id){
        return userInfoService.selectById(id);
    }
}

Controller中@RestController注解的作用：

@RestController是由@Controller和@ResponseBody组成，表示该类是controller和返回的结果为JSON数据，不是页面路径。

 

重点看一下configurer中的MyBatisConfigurer.java

package com.example.demo.core.configurer;

import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.mapper.MapperScannerConfigurer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.core.io.support.ResourcePatternResolver;

import javax.sql.DataSource;

/**
 * @author phubing
 * @Description:
 * @time 2019/4/18 11:55
 */
@Configuration
public class MybatisConfigurer {

   @Bean
   public SqlSessionFactory sqlSessionFactoryBean(DataSource dataSource) throws Exception {
      SqlSessionFactoryBean factory = new SqlSessionFactoryBean();
      factory.setDataSource(dataSource);
      factory.setTypeAliasesPackage("com.example.demo.model");
      // 添加XML目录
      ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
      factory.setMapperLocations(resolver.getResources("classpath:mapper/*.xml"));
      return factory.getObject();
   }

   @Bean
   public MapperScannerConfigurer mapperScannerConfigurer() {
      MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
      mapperScannerConfigurer.setSqlSessionFactoryBeanName("sqlSessionFactoryBean");
      mapperScannerConfigurer.setBasePackage("com.example.demo.dao");
      return mapperScannerConfigurer;
   }
}

 

@Configuration表示该文件是一个配置文件

@Bean表示该方法是一个传统xml配置文件中的

其中factory.setTypeAliasesPackage("com.example.demo.model")表示项目中model的存储路径；

factory.setMapperLocations(resolver.getResources("classpath:mapper/*.xml"));表示mapper.xml存储路径；

mapperScannerConfigurer.setBasePackage("com.example.demo.dao");表示dao层的存储路径

五：运行项目

找到DemoApplication，右键，选择run  DemoApplication

控制台打印如下信息即为启动成功

六：测试接口

打开postman（Google浏览器插件，可以去应用商店下载），输入

注意修改自己的 IP ；出现以下结构数据即访问成功

{
    "id": 1,
    "userName": "1"
}