Koala

外观

Koala System Starter ​

考拉系统管理启动模块

快速开始 ​

数据库 ​

请先参照快速开始初始化数据库

接口文档 ​

实现了字典管理/部门管理/角色管理/用户管理接口, 可通过访问接口文档查看具体信息

接口文档地址: http://${host}:${port}/swagger-ui.html

进阶 ​

权限注册 ​

可通过实现权限注册登记器接口PermissionRegistrar实现权限注册:

java
@Component
public class TestPermissionRegistrar implements PermissionRegistrar {
  
  public String getCode() {
    return "test"      
  }
  
  public List<Permission> getPermissions() {
    // 生成需要注册的权限...
  }
}
@Component
public class TestPermissionRegistrar implements PermissionRegistrar {
  
  public String getCode() {
    return "test"      
  }
  
  public List<Permission> getPermissions() {
    // 生成需要注册的权限...
  }
}

系统内置了如下权限注册登记器:

  • SimplePermissionRegistrar: 简易权限注册登记器, 支持父子两级权限注册
  • CrudPermissionRegistrar: 增删改查权限注册登记器, 根据领域名称, 自动创建父级权限和 read / create / update / delete 子级权限

可通过配置文件对权限注册登记器进行控制:

yaml
koala:
  system:
    permission-registrars:
      test:
        # 是否启用
        enabled: true
        # 是否覆盖
        overwritten: true
koala:
  system:
    permission-registrars:
      test:
        # 是否启用
        enabled: true
        # 是否覆盖
        overwritten: true

自定义服务 ​

如现有系统管理功能不满足需求, 可以通过替换指定的服务或接口来实现定制

例如, 我们要增加一个批量创建部门的接口, 可以按如下步骤进行:

  1. 创建自定义部门服务类MyDepartmentService, 实现DepartmentService接口:
java
public class MyDepartmentService implements DepartmentService {
  @Override
  public void add(Department department) {
    // 实现原接口中的新增方法
  }

  // 新增自定义的批量创建方法
  public void addInBatch(List<Department> departments) {

  }
}
public class MyDepartmentService implements DepartmentService {
  @Override
  public void add(Department department) {
    // 实现原接口中的新增方法
  }

  // 新增自定义的批量创建方法
  public void addInBatch(List<Department> departments) {

  }
}
  1. 创建自定义部门接口MyDepartmentApi, 继承DepartmentApi接口:
java
public interface MyDepartmentApi extends DepartmentApi {
  // 增加自定义的批量创建接口
  @PreAuthorize("hasAuthority('system:department:create')")
  @Operation(summary = "批量创建部门")
  @ApiResponse(responseCode = "200", description = "成功",
    content = {@Content(mediaType = "application/json", schema = @Schema(implementation = DepartmentsResult.class))}
  )
  @PostMapping
  DataResponse<List<Department>> addInBatch(@RequestBody List<DepartmentEntity> entities);
}
public interface MyDepartmentApi extends DepartmentApi {
  // 增加自定义的批量创建接口
  @PreAuthorize("hasAuthority('system:department:create')")
  @Operation(summary = "批量创建部门")
  @ApiResponse(responseCode = "200", description = "成功",
    content = {@Content(mediaType = "application/json", schema = @Schema(implementation = DepartmentsResult.class))}
  )
  @PostMapping
  DataResponse<List<Department>> addInBatch(@RequestBody List<DepartmentEntity> entities);
}
  1. 创建自定义部门接口实现类MyDepartmentApiImpl, 实现MyDepartmentApi:
java
public class MyDepartmentApiImpl implements MyDepartmentApi {
  // 使用第一步创建的自定义部门服务类
  protected final MyDepartmentService service;

  @Override
  public DataResponse<Department> add(DepartmentEntity entity) {
    // 实现原接口中的新增接口
  }

  @Override
  public DataResponse<List<Department>> addInBatch(List<DepartmentEntity> entities) {
    // 实现自定义的批量创建接口
  }
}
public class MyDepartmentApiImpl implements MyDepartmentApi {
  // 使用第一步创建的自定义部门服务类
  protected final MyDepartmentService service;

  @Override
  public DataResponse<Department> add(DepartmentEntity entity) {
    // 实现原接口中的新增接口
  }

  @Override
  public DataResponse<List<Department>> addInBatch(List<DepartmentEntity> entities) {
    // 实现自定义的批量创建接口
  }
}
  1. 将自定义的类注入到Spring IOC容器中, 最简单的方法是使用注解, 需要注意Bean名称:
java

@Component("departmentService")
public class MyDepartmentService implements DepartmentService {
}

@Component("departmentApi")
public class MyDepartmentApiImpl implements MyDepartmentApi {
}

@Component("departmentService")
public class MyDepartmentService implements DepartmentService {
}

@Component("departmentApi")
public class MyDepartmentApiImpl implements MyDepartmentApi {
}