Skip to main content

yang_base/
lib.rs

1//! yang-base - YANG 基础库
2//!
3//! 提供插件管理、数据库访问、HTTP 客户端和 JWT Token 管理等核心功能。
4//!
5//! # 模块
6//!
7//! - `plugin`:插件管理模块
8//! - `database`:数据库管理模块(MySQL / PostgreSQL 后端运行时、声明式 Schema 同步与事务句柄)
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//! - `postgres`:启用 PostgreSQL 后端(`AnyDatabase`、`Record` 解码、声明式 schema_sync,
21//!   以及 `TableQuery` / 内置 CRUD 的受保护查询与事务执行)。
22//! - `redis`:启用应用实例持有的 Redis 客户端(`token` 会自动启用它)
23//! - `validator`:启用正则表达式校验器(依赖 `regex`)
24//! - `plugin-schema`:启用插件 JSON Schema 配置验证(依赖 `jsonschema`)
25//! - `admin-metadata`:启用独立后台展示描述(不新增依赖、不改变 dispatch)
26//! - `transport-axum`:启用 Axum 0.8 HTTP 传输适配器(依赖 `axum`、`tower-http`)
27//!
28//! # 快速开始
29//!
30//! ```rust,ignore
31//! use yang_base::definition::{AppBuilder, AddonSpec};
32//! use yang_base::tools::ToolsBuilder;
33//! use yang_db::{Database, DatabaseConfig};
34//!
35//! #[tokio::main]
36//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
37//!     let database = Database::connect(
38//!         "mysql://user:pass@localhost/db",
39//!         DatabaseConfig::default(),
40//!     ).await?;
41//!     let tools = ToolsBuilder::new().mysql(database).build()?;
42//!     let app = AppBuilder::new()
43//!         .addon(AddonSpec::new(yang_base::addon!("account")))
44//!         .build(tools)?;
45//!     app.tools().mysql().health_check().await?;
46//!     Ok(())
47//! }
48//! ```
49
50// 强制公开 API 文档覆盖率检查:所有公开项必须有文档注释
51#![warn(missing_docs)]
52
53/// 当前 yang-base crate 版本。
54pub const VERSION: &str = env!("CARGO_PKG_VERSION");
55
56// 让派生宏内部的 `::yang_base::...` 路径在 yang-base 自身的测试中正常解析。
57extern crate self as yang_base;
58
59pub mod action;
60#[cfg(feature = "admin-metadata")]
61pub mod admin;
62#[cfg(feature = "redis")]
63pub mod cache;
64pub mod config;
65pub mod database;
66pub mod definition;
67pub mod error;
68#[cfg(feature = "http")]
69pub mod http;
70pub mod lifecycle;
71pub mod observability;
72pub mod plugin;
73pub mod router;
74pub mod table;
75#[cfg(feature = "token")]
76pub mod token;
77pub mod tools;
78pub mod transport;
79
80// 重新导出插件系统的核心类型,方便用户直接使用
81pub use plugin::{Plugin, PluginManager, PluginManagerBuilder, PluginRegistry};
82
83// 重新导出统一错误类型与 Result 别名,下游可直接写 yang_base::Result<T>
84pub use error::{BaseError, ErrorCategory, Result};
85
86// 重新导出派生宏
87pub use yang_base_derive::{params, Action};
88
89/// 派生宏展开所需的实现细节。**非公开 API**,业务代码禁止直接引用。
90#[doc(hidden)]
91pub mod __private {
92    pub use schemars;
93    pub use serde;
94    pub use serde_json;
95}
96
97/// 直接生成原生 [`definition::Fields`];重复字段由临时结构体在编译期拒绝。
98#[macro_export]
99macro_rules! fields {
100    ($($name:ident => $builder:expr),* $(,)?) => {{
101        const _: () = {
102            $($crate::definition::__validate_field_literal(stringify!($name));)*
103        };
104        #[allow(dead_code)]
105        struct __YangFieldNames {
106            $($name: (),)*
107        }
108        let _ = __YangFieldNames { $($name: (),)* };
109        $crate::definition::Fields::new()
110            $(.field(
111                $crate::definition::FieldName::__from_validated_literal(stringify!($name)),
112                $builder,
113            ))*
114    }};
115}
116
117/// 编译期校验的 AddonName 字面量。
118#[macro_export]
119macro_rules! addon {
120    ($value:literal) => {{
121        const _: () = $crate::definition::__validate_segment_literal($value);
122        $crate::definition::AddonName::__from_validated_literal($value)
123    }};
124}
125
126/// 编译期校验的 ModuleName 字面量。
127#[macro_export]
128macro_rules! module {
129    ($value:literal) => {{
130        const _: () = $crate::definition::__validate_ref_literal($value);
131        $crate::definition::ModuleName::__from_validated_literal($value)
132    }};
133}
134
135/// 编译期校验的 TableName 字面量。
136#[macro_export]
137macro_rules! table {
138    ($value:literal) => {{
139        const _: () = $crate::definition::__validate_segment_literal($value);
140        $crate::definition::TableName::__from_validated_literal($value)
141    }};
142}
143
144/// 编译期校验的限定 FieldRef 字面量,例如 `field!("users.id")`。
145#[macro_export]
146macro_rules! field {
147    ($value:literal) => {{
148        const _: () = $crate::definition::__validate_ref_literal($value);
149        $crate::definition::FieldRef::__from_validated_literal($value)
150    }};
151}
152
153/// 编译期校验的限定 ActionRef 字面量,例如 `action!("account.user.login")`。
154#[macro_export]
155macro_rules! action {
156    ($value:literal) => {{
157        const _: () = $crate::definition::__validate_ref_literal($value);
158        $crate::definition::ActionRef::__from_validated_literal($value)
159    }};
160}
161
162/// 编译期校验的 ActionName 字面量,例如 `action_name!("login")`。
163#[macro_export]
164macro_rules! action_name {
165    ($value:literal) => {{
166        const _: () = $crate::definition::__validate_segment_literal($value);
167        $crate::definition::ActionName::__from_validated_literal($value)
168    }};
169}
170
171/// 编译期校验的限定 ViewRef 字面量。
172#[macro_export]
173macro_rules! view {
174    ($value:literal) => {{
175        const _: () = $crate::definition::__validate_ref_literal($value);
176        $crate::definition::ViewRef::__from_validated_literal($value)
177    }};
178}
179
180/// 聚合原生 Modules;每个元素直接调用 Module::into_spec。
181#[macro_export]
182macro_rules! modules {
183    ($($module:expr),* $(,)?) => {{
184        $crate::definition::Modules::new()
185            $(.module($module))*
186    }};
187}
188
189/// 原子聚合 ActionSpec 与 Handler,不支持字符串 match。
190#[macro_export]
191macro_rules! actions {
192    ($($spec:expr => $handler:expr),* $(,)?) => {{
193        $crate::definition::Actions::new()
194            $(.action($spec, $handler))*
195    }};
196    ($($handler:expr),* $(,)?) => {{
197        $crate::definition::Actions::new()
198            $(.native($handler))*
199    }};
200}