yang_base/lib.rs
1//! yang-base - YANG 基础库
2//!
3//! 提供插件管理、数据库访问、HTTP 客户端和 JWT Token 管理等核心功能。
4//!
5//! # 模块
6//!
7//! - `plugin`:插件管理模块
8//! - `database`:数据库管理模块(支持 MySQL 和 Redis)
9//! - `http`:HTTP 客户端模块(需启用 `http` feature)
10//! - `token`:JWT Token 管理模块(需启用 `token` feature)
11//! - `error`:错误处理模块
12//! - `table`:表配置系统模块
13//! - `action`:Action 系统模块
14//!
15//! # Feature Gates
16//!
17//! - `token`:启用 JWT Token 管理功能(依赖 `jsonwebtoken`)
18//! - `http`:启用 HTTP 客户端功能(依赖 `reqwest`、`serde_urlencoded`)
19//! - `mysql`:启用 MySQL 数据库查询执行功能(依赖 `sqlx`)
20//! - `redis`:启用 Redis 全局访问功能(`token` 会自动启用它)
21//! - `validator`:启用正则表达式校验器(依赖 `regex`)
22//! - `plugin-schema`:启用插件 JSON Schema 配置验证(依赖 `jsonschema`)
23//! - `admin-metadata`:启用独立后台展示描述(不新增依赖、不改变 dispatch)
24//!
25//! # 快速开始
26//!
27//! ```rust,ignore
28//! use yang_base::plugin::{Plugin, PluginManager};
29//! use yang_base::database::{GlobalDatabase, GlobalRedis};
30//! use yang_base::http::HttpClient;
31//! use yang_base::token::TokenManager;
32//! use yang_db::{DatabaseConfig, redis::RedisConfig};
33//!
34//! #[tokio::main]
35//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
36//! // 初始化插件管理器
37//! let plugin_manager = PluginManager::new();
38//!
39//! // 初始化全局 MySQL 数据库
40//! GlobalDatabase::init("mysql://user:pass@localhost/db", DatabaseConfig::default()).await?;
41//!
42//! // 初始化全局 Redis
43//! GlobalRedis::init("redis://127.0.0.1:6379", RedisConfig::default()).await?;
44//!
45//! // 初始化 HTTP 客户端
46//! HttpClient::init_global(30)?;
47//!
48//! // 使用 MySQL
49//! let users = GlobalDatabase::table("users")?
50//! .select::<User>()
51//! .await?;
52//!
53//! // 使用 Redis
54//! GlobalRedis::set("key", "value", None).await?;
55//! let value = GlobalRedis::get("key").await?;
56//!
57//! Ok(())
58//! }
59//! ```
60
61// 强制公开 API 文档覆盖率检查:所有公开项必须有文档注释
62#![warn(missing_docs)]
63
64/// 当前 yang-base crate 版本。
65pub const VERSION: &str = env!("CARGO_PKG_VERSION");
66
67// 让派生宏内部的 `::yang_base::...` 路径在 yang-base 自身的测试中正常解析。
68extern crate self as yang_base;
69
70pub mod action;
71#[cfg(feature = "admin-metadata")]
72pub mod admin;
73pub mod config;
74pub mod database;
75pub mod error;
76#[cfg(feature = "http")]
77pub mod http;
78pub mod lifecycle;
79pub mod observability;
80pub mod plugin;
81pub mod router;
82pub mod table;
83#[cfg(feature = "token")]
84pub mod token;
85
86// 重新导出插件系统的核心类型,方便用户直接使用
87pub use plugin::{Plugin, PluginManager, PluginManagerBuilder, PluginRegistry};
88
89// 重新导出统一错误类型与 Result 别名,下游可直接写 yang_base::Result<T>
90pub use error::{BaseError, ErrorCategory, Result};
91
92// 重新导出派生宏
93pub use yang_base_derive::{Action, TableEntity};