Magic
Magic [v2.0.0] 正式发布.
简介
Use Standard C++ 11 && CMake.
基于IoC的快速开发库(C++ Rapid development library based on Inversion of Control),配合CMake构建套件开发,支持跨平台开发,并配备了更多的高性能组件.
特点
快速开发
- 高内聚,低耦合.
- 超强的通用性以及高度跨平台.
- 实现模块化开发方式便于协作开发.
- 基于 IoC
(Inversion of Control)的方式对每个类进行托管以及自动注入构建.
模块配置
- 功能模块可高度重用，方便扩展以及维护.
- 使用Json格式配置文件
(*.magic)对功能进行模块划分.
非侵入式
- 高度解耦
- 代码移植度高.
- 无任何侵入式代码.
安装
只需支持C++11的编译器以及CMake构建工具编译即可, MySql、OpenSSl 编译可选项.
- Linux
- Gnu构建套件 (跳转在库路径中)
mkdir build && cd build && cmake ../. && make && make install
- Ninja构建套件 (推荐.跳转在库路径中)
mkdir build && cd build && cmake -GNinja ../. && ninja && ninja install
- Win
- VS 20XX
cmake -G "Visual Studio 15 2017"// or Visual Studio xx 20xx
- VS 20XX
*.magic模块每次被修改完成时,请调用一次cmake ../.
使用方法
-
使用本库工具 Magic/Bin/Create
-
创建项目文件目录名,跳转项目文件目录中
-
使用
Create Test /root/Magic创建项目模板, (Test 项目名) ("/root/Magic" Magic库路径) -
当前目录会生成 CMakeLists.txt Main.cpp Test.magic三个文件
-
查看Test项目文件夹中CMakeLists.txt文件.
#Please Add The Directory Path Of The Magic Library.
set(MAGIC /root/Magic)
if(NOT DEFINED MAGIC)
message(FATAL_ERROR "Please Add The Directory Path Of The Magic Library!!!")
endif()
include_directories(
${MAGIC}
${MAGIC}/Include
${PROJECT_SOURCE_DIR}
${PROJECT_SOURCE_DIR}/Include
${MAGIC}/ThirdParty/Asio/Include
${MAGIC}/ThirdParty/RapidJSON/Include
)
link_directories(
${MAGIC}/Lib
)
link_libraries(Magic)
include(${MAGIC}/Magic.cmake)
add_custom_target(Gen ALL)
add_custom_command(
TARGET Gen
COMMAND ${MAGIC}/Bin/Gen ${MAGIC}/Magic.magic Test
)- 打开Test.magic配置文件,并添加上自定义的类.
{
"Configurations":{
"NameSpace":"Test", // 同 C++ 的namespace
"Registered":[ // 类信息注册(强制,必须要具有一个).
{
"Id":"", // 类Id标识(任意名).
"Class":"", // 类名,如果有namespace,则需加上即可(XXX::ClassName).
"Interface":"", // 继承的接口类,通常需要抽象的时候才使用.
"IncludePath": "", // 类所在的文件路径(如何有相同的可以忽略).
"Dependencies":[], // 依赖的其他类的类名.
"FunctionPropertys":[] // 需要注册的属性函数.
}
],
"Initialize":[ // 初始化(非强制)
{
"Id":"", // 类Id标识应与上方Registered中一致.
"Loop":false, // Loop 循环初始化
"Callee":"", // 被调用的接口类类型 若Loop == true则该属性必须具有值.
"CalleeFunctions":[], // 被调用的函数.
"InvokeFunctions":{} // 函数中对应的 RAW Arguments. “XX”:["XXX"]写法.
}
],
"Constructor":{ // 构造函数定义
"Name":"Initialize", // 暴露给main函数中调用名.
"WithParameter": false // 是否需要自定义注册参数.
}
}
}- 对CMake配置文件进行编辑添加Test模块(Test.magic)
add_custom_command(
TARGET Gen
COMMAND ${MAGIC}/Bin/Gen ${MAGIC}/Magic.magic ${PROJECT_SOURCE_DIR}/Test.magic Test
)- 跳转build目录中 调用
cmake ../.或cmake ../. -Gxxx并且进行Build. - 打开Main.cpp源文件
#include "Test.h" //添加头文件
int main(){
Test::Initialize(); //添加初始化代码. [Configurations.NameSpace]::[Constructor.Name]命名设定
return EXIT_SUCCESS;
}- 编译即可
本库示例
配置文件：Magic模块 (可使用多个配置文件)
{ // 日志以及配置模块示例
"Configurations":{
"NameSpace":"Magic", // 同C++的namespace.
"Registered":[ // 类信息注册(强制,必须要具有一个).
{
"Id":"config", // 类Id标识(任意名).
"Class":"Magic::Config", // 类名,如果有namespace,则需加上即可.
"IncludePath": "Include/Core/Config.h", // 类所在的文件路径(如何有相同的可以忽略).
"Interface":"", // 继承的接口类,通常需要抽象的时候才使用.
"Dependencies":[], // 依赖的其他类的类名.
"FunctionPropertys":["addConfigFile"] // 需要注册的属性函数.
},
{
"Id":"configFile", // 与Magic::Config同文件,则不需要在此定义IncludePath
"Class":"Magic::ConfigFile",
"FunctionPropertys":["addFormatter"]
},
......
],
"Initialize":[ // 初始化(非强制)
{
"Id":"logger",
"Loop":true, // Loop 循环加入接口类对象
"Callee":"Magic::ILogAppender", // 接口类类型 若Loop == true则该属性必须具有值.
"CalleeFunctions":["addILogAppender"], // 接口类对象添加函数.
}
],
"Constructor":{ // 构造函数定义
"Name":"Initialize", // 暴露给main函数中调用名.
"WithParameter": false // 是否需要自定义注册参数.
}
}
}.....
其他
- 基础用法&演示地址一
- Web服务端&演示地址二
- (未完待续).....