kvf-admin 项目使用教程

kvf-admin 项目使用教程

1. 项目的目录结构及介绍

kvf-admin 项目的目录结构如下：

kvf-admin
│
├─ pom.xml          # Maven 依赖管理文件
│
├─ sql
│   └─ kvf_sys.sql   # 项目初始化数据表及基础数据 SQL 脚本
│
└─ src
    ├─ main
    │   ├─ java
    │   │   └─ com
    │   │       └─ kalvin
    │   │           └─ kvf
    │   │               │
    │   │               ├─ KvfAdminApplication.java  # 项目启动类
    │   │               │
    │   │               ├─ common                   # 通用模块
    │   │               └─ modules                 # 功能模块
    │   │                   ├─ generator           # 代码生成器模块
    │   │                   └─ sys                 # 系统模块（核心）
    │   │
    │   └─ resources
    │       │
    │       ├─ application.yml  # Spring Boot 配置文件
    │       └─ ehcache.xml      # Ehcache 缓存配置文件
    │
    └─ test
        └─ java
            └─ com
                └─ kalvin
                    └─ kvf
                        └─ kvf-admin  # 测试类

目录结构说明

• pom.xml: Maven 项目依赖管理文件，定义了项目的依赖和插件。
• sql/kvf_sys.sql: 项目初始化数据表及基础数据的 SQL 脚本。
• src/main/java/com/kalvin/kvf/KvfAdminApplication.java: 项目启动类，负责启动 Spring Boot 应用。
• src/main/java/com/kalvin/kvf/common: 通用模块，包含一些通用的工具类和配置。
• src/main/java/com/kalvin/kvf/modules: 功能模块，包括代码生成器模块和系统模块。
• src/main/resources/application.yml: Spring Boot 配置文件，配置应用的各项参数。
• src/main/resources/ehcache.xml: Ehcache 缓存配置文件，定义缓存策略。

2. 项目的启动文件介绍

项目的启动文件是 KvfAdminApplication.java，位于 src/main/java/com/kalvin/kvf/KvfAdminApplication.java。

启动文件内容

package com.kalvin.kvf;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class KvfAdminApplication {

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

启动文件说明

• @SpringBootApplication: 这是一个组合注解，包含了 @Configuration、@EnableAutoConfiguration 和 @ComponentScan，用于启动 Spring Boot 应用。
• main 方法: 应用的入口点，通过 SpringApplication.run 方法启动 Spring Boot 应用。

3. 项目的配置文件介绍

项目的配置文件是 application.yml，位于 src/main/resources/application.yml。

配置文件内容示例

server:
  port: 8080

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/kvf_admin?useUnicode=true&characterEncoding=utf-8&useSSL=false
    username: root
    password: root

mybatis:
  mapper-locations: classpath:mapper/*.xml
  type-aliases-package: com.kalvin.kvf.modules.sys.entity

logging:
  level:
    com.kalvin.kvf: debug

配置文件说明

• server.port: 配置应用的端口号，默认为 8080。
• spring.datasource: 配置数据库连接信息，包括数据库 URL、用户名和密码。
• mybatis: 配置 MyBatis 的相关参数，如 Mapper 文件位置和实体类包路径。
• logging.level: 配置日志级别，可以针对不同的包设置不同的日志级别。

以上是 kv