# kantboot-start

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

## Basic Information

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

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-12-21
- **Last Updated**: 2024-01-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## Kantboot基础架构
## 1、常用示例
### 1.1、RestResult（通用工具类）
这是一个方便用户在rest操作的工具类
#### 以下是返回成功信息案例
```java
public class DemoController {
    @GetMapping("/demo")
    public RestResult demo(){
        // 任意类，此处以SysUser类为例
        SysUser user = new SysUser();
        user.setId(1L);
        user.setUsername("admin");
        user.setPassword("123456");
        
        // 第一个参数为返回的数据，第二个参数为返回的状态码，第三个参数为返回的信息
        return RestResult.success(user,"getSuccess","获取成功");
        // 当有国际化字典时，可以直接使用国际化字典中的信息，不需要第三个参数
        // return RestResult.success(user,"getSuccess");
    }
}
```

### 1.2、BaseException（通用异常类）
这是一个方便用户在抛出异常时使用的工具类
#### 以下是抛出异常案例
```java

public class DemoService{
    public void demo(SysUser user){
        if(user.getId() == null){
            // 第一个参数为异常的状态码，第二个参数为异常的信息
            throw BaseException.of("getFail","获取失败");
            // 如果在国际化字典中找到了对应的信息，可以直接使用国际化字典中的信息，不需要第二个参数
            // throw BaseException.of("getFail");
        }
    }
}
```

### 1.3、BaseAdminController（通用管理后台控制器）
这是一个方便用户在管理后台使用的工具类，当controller继承此类时，会自带增删改的接口
#### 以下是管理后台控制器案例
```java
@RestController
@RequestMapping("/demo")
public class DemoController extends BaseAdminController<SysUser,Long> {
}
```

### 1.5、快速获取登录的用户
#### 以下是获取用户的案例

```java
import jakarta.annotation.Resource;
import org.springframework.stereotype.Service;
import com.kantboot.system.user.service.ISysUserService;

import java.util.Map;

@Service
public class DemoService {

    @Resource
    private ISysUserService userService;

    public void demo() {
        // 获取当前登录用户id
        Long userId = userService.getSelfId();
        // 获取当前登录用户信息
        SysUser user = userService.getSelf();
        // 获取经过处理过，更易于前端展示的用户信息
        Map<String, Object> selfMap = userService.getSelfMap();
    }
}
```



## 2、对应包
### 2.1、util
#### 2.1.1、util-common（通用工具类）
查看对应 <a href="src/main/java/com/kantboot/util/common/README.md">README.md</a>
#### 2.1.2、util-core（核心工具类）
查看对应 <a href="src/main/java/com/kantboot/util/core/README.md">README.md</a>