1 Star 3 Fork 2

若汝棋茗 / Baboon

Create your Gitee Account
Explore and code with more than 12 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README
Apache-2.0

Baboon

介绍

这是一个轻量级wpf插件化开发的基础库。它内置了模块化加载、模块化日志记录、模块化本地存储、模块化IOC注册、以及开发Mvvm必要的Command和EventTrigger。

安装教程

nuget安装Baboon即可。

Install-Package Baboon

使用

安装完成以后,需要在App.xaml和.cs中,修改基类继承。

<baboon:BaboonApplication x:Class="Baboon.Wpf.App"
                          xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
                          xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
                          xmlns:baboon="clr-namespace:Baboon;assembly=Baboon">
    <Application.Resources />
</baboon:BaboonApplication>

同时需要在App.xaml.cs中,实现抽象类成员。包括注册容器和创建主窗口。

public partial class App : BaboonApplication
{
    protected override Window CreateShell()
    {
        //创建主窗口
        return this.Container.Resolve<MainWindow>();
    }

    protected override void RegisterTypes(IContainer container)
    {
        //注册容器
        container.RegisterSingletonView<MainWindow,MainViewModel>();
    }
}

新建模块

新建一个项目,命名为SayHello.Module,添加对Baboon的引用。

然后新建一个类,命名为SayHelloModule,继承自AppModuleBase或实现IAppModule接口。

然后实现基本成员。

public class SayHelloModule : AppModuleBase
{
    public SayHelloModule(ILoggerFactoryService loggerFactory) : base(loggerFactory)
    {
       
    }

    public override ModuleDescription Description { get; }

    public override ImageSource Icon => throw new NotImplementedException();

    public override void Show(object parameter = null)
    {
        MessageBox.Show("Hello");
    }
}

ModuleDescription是模块描述,可以直接赋值,也可以通过xml文件定义。

<?xml version="1.0" encoding="utf-8"?>
<package>
	<metadata>
		<Id>SayHello</Id>
		<DisplayName>SayHello</DisplayName>
		<Version>1.0.0</Version>
		<Authors>RRQM</Authors>
		<Description>会弹出Hello</Description>
		<!--<CoverImage>logo.png</CoverImage>-->
		<HasView>false</HasView>
	</metadata>
	<module>SayHello.Module.dll</module>
</package>

注册模块

在App中,重写ConfigureModuleCatalog。可以注册模块。

注册的方式有三种,实例注册、类型注册、构建器注册。

实例注册和类型注册,时直接将模块注册到主程序。这会立刻加载模块,并且需要主程序引用模块。

构建器注册则是只注册模块信息,等需要模块的时候,自动加载模块。并且不需要主程序引用模块。

public partial class App : BaboonApplication
{
    ...

    protected override void ConfigureModuleCatalog(IModuleCatalog moduleCatalog)
    {
        //以实例注册
        moduleCatalog.Add(new SayHelloModule(this.Container.Resolve<ILoggerFactoryService>()));

        //以类型注册
        moduleCatalog.Add(typeof(SayHelloModule));

        //以构建器注册
        moduleCatalog.Add(new ModuleDescriptionBuilder()
        {
            Description = new ModuleDescription(),
            Module = "",
            RootDir = ""
        });
    }
}

加载、使用模块

模块的加载是自动的,即使使用构建器注册的。也会在需要时时机加载模块。

使用模块,需要从容器中获得IModuleCatalog。

然后可以Contains(id)的方法,判断是否已注册对应Id的模块。

通过TryGetAppModuleInfo可以获取到模块信息。

appModuleInfo.Loaded属性可以判断当前模块是否已经加载到主程序中。

appModuleInfo.GetApp()即可获取到指定的模块。

internal class MainViewModel : ViewModelBase
{
    private readonly IModuleCatalog m_moduleCatalog;

    public MainViewModel(IModuleCatalog moduleCatalog)
    {
        this.m_moduleCatalog = moduleCatalog;
    }

    private void RunSayHello()
    {
        if (!this.m_moduleCatalog.Contains("SayHello"))
        {
            MessageBox.Show("没有找到模块");
        }

        if (this.m_moduleCatalog.TryGetAppModuleInfo("SayHello", out var appModuleInfo))
        {
            if (!appModuleInfo.Loaded)//没有加载到主程序
            {
                if (MessageBox.Show("模块没有加载,是否加载?", "", MessageBoxButton.YesNo) == MessageBoxResult.Yes)
                {
                    var app = appModuleInfo.GetApp();

                    app.Show();
                }
            }
            else
            {
                var app = appModuleInfo.GetApp();

                app.Show();
            }
        }
    }
}

模块管理器

使用IModuleManagerService服务,可以实现对模块的快速管理。包括安装、更新、卸载等。

同时IModuleCatalog也会对存放在Modules文件夹下的所有模块进行注册。但前提是每个模块必须包含一个名为Description.xml的文件。

模块日志

每个模块可以拥有单独的日志记录器。通过IAppModule.Logger即可获得。

模块本地数据库

Baboon集成了LiteDB数据库,并封装了KV键值存储。使用IConfigurationStoreService即可。

Mvvm

Baboon简单的封装了基本的Mvvm框架,基本能满足使用。

【Cammand】

ExecuteCommand类。

【ViewModel】

ObservableObject和ViewModelBase类。

【容器注册View并绑定】

public partial class App : BaboonApplication
{
    ...
    protected override void RegisterTypes(IContainer container)
    {
        container.RegisterSingletonView<MainWindow, MainViewModel>();
    }
}

【绑定事件触发器】

使用EventAction实现。

参与贡献

  1. Fork 本仓库
  2. 新建 Feat_xxx 分支
  3. 提交代码
  4. 新建 Pull Request
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

About

这是一个轻量级wpf插件化开发的基础库。它内置了模块化加载、模块化日志记录、模块化本地存储、模块化IOC注册、以及开发Mvvm必要的Command和EventTrigger。 expand collapse
C#
Apache-2.0
Cancel

Releases

No release

Contributors

All

Activities

Load More
can not load any more
C#
1
https://gitee.com/RRQM_Home/baboon.git
git@gitee.com:RRQM_Home/baboon.git
RRQM_Home
baboon
Baboon
master

Search

53164aa7 5694891 3bd8fe86 5694891