基础构建

Maven添加依赖

中央仓库查询：https://search.maven.org/

阿里仓库查询：https://maven.aliyun.com/mvn/search

<dependency>
  <groupId>com.starmcc</groupId>
  <artifactId>qm-framework</artifactId>
  <version>1.1.1</version>
</dependency>

注意：框架底层依赖springboot2.1.0以上版本。

已依赖mybatis-spring-boot-starter，spring-boot-starter-web

下面是一套基础的Maven配置

<?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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.0.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.starmcc</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1</version>
    <name>demo</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>com.starmcc</groupId>
            <artifactId>qm-framework</artifactId>
            <version>1.1.1</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

创建配置文件

在框架中默认读取qm-application.properties文件。

该配置文件可设置框架中的一些基础设置。

创建qm-application.properties文件

#※※※※※※※※※AES加密设置※※※※※※※※※
#是否启用aes对称加密传输
aes.start=false
#aes秘钥
aes.key=ohiah2019sDShdieub51h8910s
#统一使用的编码方式
aes.encoding=UTF-8
#加密次数
aes.number=1
#※※※※※※※※※请求响应设置※※※※※※※※※
#请求数据时，根据该key名解析数据(rest风格)
body.request.key=value
#返回数据时，使用的最外层key名(rest风格)
body.response.key=value
#返回数据时，默认message的语言 EN/CN
body.response.message.lang=CN
#※※※※※※※※※版本控制※※※※※※※※※
#是否开启版本控制(ture时,每个请求需在header带上version参数,参数值version)
version.start=false
#系统目前版本编号
version.now=1.0.0
#系统容忍请求版本编号(默认允许当前版本)
version.allows-[0]:0.9.8
version.allows-[1]:0.9.9

#※※※※※※※※※特殊请求过滤※※※※※※※※※
#特殊请求不进行解析(包括版本控制和解析json等)
#该配置主要排除第三方API调用接口时特殊请求而框架自动解析json的问题
#适用于动态配置，例：/user/**
request.special.uri-[0]=

创建数据源配置文件db.properties

#※※※※※※※※※※※※※※※※※※ 数据源配置 ※※※※※※※※※※※※※※※※※※
# 驱动名
driver-class-name=com.mysql.cj.jdbc.Driver
# 连接地址
url=jdbc:mysql://localhost:3306/test
# 用户名
username=root
# 密码
password=123

这是基础的配置，数据源可进行其他拓展的配置，详细留意【配置模板】 (opens new window)

---

这里以 spring boot + mybatis 的模式为例，设置applicatio.yml

server:
  port: 80

mybatis:
  type-aliases-package: com.starmcc.demo.entity # 指定实体类包路径
  configuration:
    map-underscore-to-camel-case: true #是否启动数据库下划线自动映射实体
    auto-mapping-behavior: full # resultMap 自动映射级别设置
  mapper-locations: classpath:mapper/*.xml

进入开发

application启动类配置@MapperScan

@SpringBootApplication
@Import({
        QmFrameworkApplication.class,
        QmExceptionHandler.class,
    	
})
@MapperScan("com.starmcc.demo.dao")
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

}

上方使用 @Import 导入框架配置

QmFrameworkApplication 是框架的主配置类，请必须导入它。

QmExceptionHandler是全局异常配置类，导入即启用全局异常捕获，并以json的形式返回。建议导入。

其他配置请参考相关功能点说明。

---

启动项目，数据库配置没有错误的情况下，启动成功！

一套从Controller到Dao的类和方法，结构如下。