Anno Admin 技术文档

Anno Admin 技术文档

【免费下载链接】anno-admin Anno-Admin是一个开源项目，旨在通过注解生成后台管理系统。它可以帮助开发者更轻松地创建功能强大的后台管理系统，无需手动编写大量代码。使用Anno-Admin，只需在代码中添加注解，就可以自动生成各种功能，包括用户管理、权限管理、数据管理等。这个项目适合需要快速开发后台管理系统的开发者，也适合想学习注解和代码生成技术的开发者。 项目地址: https://gitcode.com/Cmeet/anno-admin

1. 安装指南

环境要求

• JDK 17+
• Maven 3.6+
• 支持的数据库：MySQL/H2/SQLite/Oracle/PostgreSQL等主流数据库

Maven依赖安装

在项目的pom.xml中添加以下依赖：

<dependency>
    <groupId>site.sorghum</groupId>
    <artifactId>anno-admin</artifactId>
    <version>1.2.3</version>
</dependency>

基础配置

在application.yml中添加最小配置：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/anno_admin
    username: root
    password: 123456
anno:
  admin:
    enable: true

2. 项目使用说明

核心注解

1. @AnnoMain：标注主类，定义表名和显示名称

@AnnoMain(name = "用户管理", tableName = "sys_user")
public class User {}

2. @AnnoField：定义字段属性

@AnnoField(title = "用户名", table = "sys_user")
private String username;

快速开始

1. 创建一个实体类并添加注解
2. 启动SpringBoot/Solon应用
3. 访问/anno-admin进入管理界面

功能特性

• 自动生成CRUD界面
• 支持逻辑删除、数据权限控制
• 内置多种字段类型：图片上传、富文本、树形选择等
• 支持多数据源配置

3. 项目API使用文档

核心API接口

1. 数据查询API

GET /anno-api/{entityName}/list
参数：page, size, sort, filter条件

2. 数据新增API

POST /anno-api/{entityName}
Body: JSON格式的实体数据

3. 数据更新API

PUT /anno-api/{entityName}/{id}
Body: JSON格式的更新数据

4. 数据删除API

DELETE /anno-api/{entityName}/{id}

扩展API

1. 自定义业务逻辑：

@AnnoButton(name = "自定义操作")
public void customMethod(AnnoContext context) {
    // 业务逻辑
}

2. 数据源扩展： 实现AnnoDataSource接口可自定义数据源

4. 项目安装方式

方式一：Maven中央仓库

<dependency>
    <groupId>site.sorghum</groupId>
    <artifactId>anno-admin</artifactId>
    <version>1.2.3</version>
</dependency>

方式二：本地构建

1. 克隆项目：

git clone https://gitee.com/cmeet/anno-admin.git

2. 构建项目：

mvn clean install

3. 引入本地构建的jar包

插件扩展

1. 缓存插件：

<dependency>
    <groupId>site.sorghum</groupId>
    <artifactId>anno-admin-cache-redis</artifactId>
    <version>1.2.3</version>
</dependency>

2. 文件存储插件：

<dependency>
    <groupId>site.sorghum</groupId>
    <artifactId>anno-admin-x-file-storage</artifactId>
    <version>1.2.3</version>
</dependency>

注意事项

1. 首次启动会自动创建所需表结构
2. 默认管理员账号：16666666666/16666666666
3. 生产环境建议配置Redis缓存

【免费下载链接】anno-admin Anno-Admin是一个开源项目，旨在通过注解生成后台管理系统。它可以帮助开发者更轻松地创建功能强大的后台管理系统，无需手动编写大量代码。使用Anno-Admin，只需在代码中添加注解，就可以自动生成各种功能，包括用户管理、权限管理、数据管理等。这个项目适合需要快速开发后台管理系统的开发者，也适合想学习注解和代码生成技术的开发者。 项目地址: https://gitcode.com/Cmeet/anno-admin