# kantboot-start-parent

**Repository Path**: bygo/kantboot-start-parent

## Basic Information

- **Project Name**: kantboot-start-parent
- **Description**: No description available
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-06-26
- **Last Updated**: 2022-02-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Kantboot基础架构

## 1、简介

>1、Kantboot-db-common
>
>​	数据库表代码生成器，根据数据库表名和字段生成mapper、servise、entity层
>
>2、kantboot-file
>
>​	文件管理，对文件上传进行操作，关联数据库，提供对应id和对应url以供获取文件
>
>3、kantboot-redis-session
>
>​	Redis数据操作，提供便捷的Redis获取和传入信息的类
>
>4、kantboot-util-common
>
>​	常用工具，提供便捷的文件读取、网络传输和一些基类
>
>5、kantboot-wechat-applet
>
>​	微信小程序操作，微信小程序的基本操作类
>
>6、kantboot-wechat-pay
>
>​	微信支付操作，微信支付的基本操作类



## 2、开发环境

>1、JDK 1.8 或以上版本
>
>2、Maven 3.6 或以上版本



## 3、Maven配置以及依赖

### 3.1、setting.xml配置

```xml
<?xml version="1.0" encoding="UTF-8"?>
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0     http://maven.apache.org/xsd/settings-1.0.0.xsd">
    <mirrors>
        <mirror>
            <id>kantbootmaven</id>
            <mirrorOf>central</mirrorOf>
            <name>kantboot maven</name>
            <url>https://maven.bywlkjs.com/repository/maven-public/</url>
        </mirror>
    </mirrors>

    <profiles>
        <profile>
            <id>jdk-1.8</id>
            <activation>
                <activeByDefault>true</activeByDefault>
                <jdk>1.8</jdk>
            </activation>
            <properties>
                <maven.compiler.source>1.8</maven.compiler.source>
                <maven.compiler.target>1.8</maven.compiler.target>
                <maven.compiler.compilerVersion>1.8</maven.compiler.compilerVersion>
            </properties>
        </profile>
    </profiles>
</settings>
```



### 3.2、依赖

```xml
<!-- 可以用作项目的父级依赖 -->
<parent>
  <groupId>com.kantboot</groupId>
  <artifactId>kantboot-starter-parent</artifactId>
  <version>0.0.2</version>
  <type>pom</type>
</parent>

<!-- Kantboot-db-common[数据库表代码生成器] -->
<dependency>
  <groupId>com.kantboot</groupId>
  <artifactId>kantboot-db-common</artifactId>
  <version>0.0.2</version>
</dependency>

<!-- kantboot-file[文件管理] -->
<dependency>
  <groupId>com.kantboot</groupId>
  <artifactId>kantboot-file</artifactId>
  <version>0.0.2</version>
</dependency>

<!-- kantboot-redis-session[Redis数据操作] -->
<dependency>
  <groupId>com.kantboot</groupId>
  <artifactId>kantboot-redis-session</artifactId>
  <version>0.0.2</version>
</dependency>

<!-- kantboot-util-common[常用工具] -->
<dependency>
  <groupId>com.kantboot</groupId>
  <artifactId>kantboot-util-common</artifactId>
  <version>0.0.2</version>
</dependency>

<!-- kantboot-wechat-applet[微信小程序操作] -->
<dependency>
  <groupId>com.kantboot</groupId>
  <artifactId>kantboot-wechat-applet</artifactId>
  <version>0.0.2</version>
</dependency>

<!-- kantboot-wechat-pay[微信支付操作] -->
<dependency>
  <groupId>com.kantboot</groupId>
  <artifactId>kantboot-wechat-pay</artifactId>
  <version>0.0.2</version>
</dependency>
```



## 4、 Kantboot-db-common[数据库表代码生成]

### 4.1、依赖

```xml
<!-- Kantboot-db-common[数据库表代码生成器] -->
<dependency>
  <groupId>com.kantboot</groupId>
  <artifactId>kantboot-db-common</artifactId>
  <version>0.0.2</version>
</dependency>
```

### 4.2、用法

```java
DbCommonServiceImpl dbCommonServiceImpl=new DbCommonServiceImpl();

CreateDatabaseDTO createDatabaseDTO=
	new CreateDatabaseDTO()
		.setAuthor("author") //作者名
  	.setDatabaseUrl("jdbc:mysql://xxx.xxx.xxx/xxx&...") //数据库地址
    .setDatabaseUsername("username") //数据库名称
    .setDatabasePassword("password") //数据库密码
    .setIdType(CreateDatabaseDTO.ID_TYPE_AUTO) //主键策略
  	.setOutputDir("...") //代码生成路径
    //数据库驱动，默认值：com.mysql.cj.jdbc.Driver
    .setDatabaseDriverName("com.mysql.cj.jdbc.Driver")
    //父级包名：默认值：com.kantboot
    .setPackageParentName("com.kantboot")
    //模块名，默认值：by
    .setPackageModuleName("by")
    //控制层包名，默认值：controller，生成时：父级包名+"."+模块名+"."+控制层包名
    .setPackageControllerName("controller")
    //实体类包名，默认值：entity，生成时：父级包名+"."+模块名+"."+实体类包名
    .setPackageEntityName("entity")
    //业务层包名，默认值：service，生成时：父级包名+"."+模块名+"."+业务层包名
    .setPackageServiceName("service")
    //dao层包名，默认值：mapper，生成时：父级包名+"."+模块名+"."+DAO层包名
    .setPackageMapperName("mapper")
  	//是否打开资源管理器(0 否，1 是)，默认为否(0)
  	.setIsOpenResourceManager(0)
  	//重新生成时文件是否覆盖(0 否，1 是)，默认为否
  	.setIsFileOverride(0)
  	//是否开启swagger(0 否，1 是)，默认为否
  	.setIsSwagger(0);

//生成数据库实体类
dbCommonService.toGenerator(createDatabaseDTO);
```



## 5、kantboot-file[文件管理]
### 5.1、依赖

```xml
<!-- kantboot-file[文件管理类] -->
<dependency>
  <groupId>com.kantboot</groupId>
  <artifactId>kantboot-file</artifactId>
  <version>0.0.2</version>
</dependency>
```



### 5.2、用法

#### 5.2.1、添加数据库表

已MySQL为例：

```mysql
DROP TABLE IF EXISTS `ces_kantboot_file`;
CREATE TABLE `ces_kantboot_file` (
  `id` bigint NOT NULL AUTO_INCREMENT COMMIT 'ID',
  `path` varchar(255) DEFAULT NULL COMMIT '文件路径',
  `type_str` varchar(255) DEFAULT NULL COMMIT '文件类型',
  `is_delete` int DEFAULT '0' COMMIT '逻辑删除（0 否，1 是）',
  `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP COMMIT '创建时间',
  `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMIT '最后一次修改时间',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=41 DEFAULT CHARSET=utf8mb3;

```



#### 5.2.2、添加配置

```java
//启动类添加此注解
@ComponentScan(basePackages = {"com.kantboot"})
```

例：

```java
@SpringBootApplication
//启动类添加此注解
@ComponentScan(basePackages = {"com.kantboot"})
public class DemoApplication {

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

}
```



#### 5.2.3、上传文件


>URL：{{url}}/kantboot/file/upload/{{file_type}}
>
>参数说明：
>
>> url：地址
>> file_type：文件类型，字符串形式
>
>
>
>例：http://localhost:8080/kantboot/file/upload/image
>
>请求参数说明：
>
>> file：文件
>
>
>
>上传成功时：
>
>>{
>>	"state": 2000,
>>	"msg": "上传成功",
>>	"errMsg": null,
>>	"data": {
>>		"id": 41,
>>		"typeStr": "image"
>>	}
>>}



#### 5.2.4、查看文件

> URL：{{url}}/kantboot/file/view/{{typeStr}}/{{id}}
>
> 参数说明：
>
> > url：地址
> >
> > file_type：文件类型
> >
> > id：文件存放在数据库中的id
>
> 
>
> 例：http://localhost:8080/kantboot/view/image/1



## 6、kantboot-redis-session[Redis数据操作]

### 6.1、依赖

```xml
<!-- kantboot-redis-session[Redis数据操作] -->
<dependency>
  <groupId>com.kantboot</groupId>
  <artifactId>kantboot-redis-session</artifactId>
  <version>0.0.2</version>
</dependency>
```

### 6.2、添加配置

```java
//启动类添加此注解
@ComponentScan(basePackages = {"com.kantboot"})
```

例：

```java
@SpringBootApplication
//启动类添加此注解
@ComponentScan(basePackages = {"com.kantboot"})
public class DemoApplication {

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

}
```



### 6.3、用法