# vt-java

**Repository Path**: weena/vt-java-temp

## Basic Information

- **Project Name**: vt-java
- **Description**: There is fucking nothing
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2022-09-29
- **Last Updated**: 2024-08-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## VT-JAVA-TEMPLATE

## 说明

### Mapper

工程中利用 `Mybatis Generator` 自动生产实体类以及Mapper层接口，下面介绍生成过程：

1. 配置 `generatorConfig.xml` 文件，文件中配置了数据库、所有生成的表以及生成文件的位置，根据实际做相应修改

2. 使用 maven 命令 `mvn mybatis-generator:generate` 生成对应的实体类、接口以及Mapper文件

注: 工程使用 `tk.mybatis` 实现单表操作，Mapper接口中可添加自定义方法来实现更多操作

### Service

可抛出异常，建议抛出自定义异常 `ServiceException` 禁止在 Service 层直接返回 Http 响应

### Controller

Swagger 配置: config.SwaggerConfig

Swagger UI: http://localhost:8080/swagger/index

### 统一返回消息格式

工程建议接口设计符合 `RESTFUL` 风格设计，对于返回结果遵循以下结构

```json
{
  code: 200,
  message: '',
  data: []
}
```

响应结果类在 response 目录下，code 定义可实现 response.RespStatusCode 类并修改

### 统一异常处理

配置: exception.ExceptionControllerAdvice

工程使用 `@RestControllerAdvice` 实现统一异常处理，可以在配置类中增加更多的异常类型并处理

### 日志

代码中使用 `Slf4j` 记录代码运行日志

```java
import lombok.extern.slf4j.Slf4j;

@Slf4j
class Test {

    // 引入logger类
    private final Logger log = LoggerFactory.getLogger(Test.class);

    log.info("info {}","...");
    log.error("error");
    log.warn("warn");
}
```

配置文件：logback-spring.xml

### 配置

application.xml 中定义项目基本参数

application-dev.xml 开发环境

application-prod.xml 生产环境

### 打包与部署

打包指令: mvn clean package -DskipTests

部署方式一：jar包 + Windows 部署

部署方式二：war包 + Tomcat 部署

部署方式三：docker plugin **dockerfile maven plugin**

```sh
mvn -DskipTests=true clean package

docker run -p 8081:8080 -itd lauset/angel:1.0.1
```