# 基础构建

# 前言

基础搭建如不想看文档，可参照提供的示例项目

https://github.com/starmcc/framework-demo

该项目完整的贴出怎么进行配置。

# Maven添加依赖

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

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

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

1
2
3
4
5

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

已依赖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 https://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.5.5</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.starmcc.demo</groupId>
    <artifactId>framework</artifactId>
    <version>0.0.1</version>
    <name>framework</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>com.starmcc</groupId>
            <artifactId>qm-framework</artifactId>
            <version>2.1.1-RELEASE</version>
        </dependency>
    </dependencies>

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

</project>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

# 添加配置

在springboot中的application.yml添加下列配置。

qmframework:
 # ※※※※※※※※※通讯配置※※※※※※※※※
 transmit: 
   # 请求数据时，最外层的key名(rest风格)
   request-key: 'value'
   # 返回数据时，最外层的key名(rest风格)
   response-key: 'value'
   # 返回数据时，默认message的语言 EN/CN
   response-message-lang: EN

1
2
3
4
5
6
7
8
9

# 进入开发

application启动类配置@MapperScan

@SpringBootApplication
@Import({
        QmFrameworkApplication.class, // qm-framework 主要依赖配置
        QmExceptionHandler.class, // qm-framework 引入全局异常捕获
})
public class DemoApplication {

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

}

1
2
3
4
5
6
7
8
9
10
11
12

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

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

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

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

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

← Qm-Framework 配置模板 →