1 Star 0 Fork 62

杨帆 / NCF

forked from NeuCharFramework / NCF 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

NCF - NeuCharFramework

NeuCharFramework(NCF) 是一整套可用于构建基础项目的框架,包含了基础的缓存、数据库、模型、验证及配套管理后台,模块化,具有高度的可扩展性。

当前版本:0.1.0-beta4

说明:NCF 由盛派(Senparc)团队经过多年优化迭代的自用系统底层框架 SenparcCore 整理而来,经历了 .NET 3.5/4.5 众多系统的实战检验,并最终移植到 .NET Core,目前已在多个 .NET Core 系统中稳定运行,在将其转型为开源项目的过程中,需要进行一系列的重构、注释完善和兼容性升级,目前尚处于雏形阶段,希望大家多提意见,我们会争取在最短的时间内优化并发布第一个试用版(Preview1)。感谢大家一直以来的支持!

Preview1 版本中,我们将提供更加完善的模块化架构和辅助工具,当前源码已经可用于学习和测试使用。

当前快速更新分支:Developer

我们欢迎第三方开源组件提供自己的解决方案,我们将会测试并集成到 NCF 中。

NCF 除了会为大家提供完善的框架代码,我们还在着手:

  1. 提供完善的项目自动生成服务(参考 WeChatSampleBuilder),为开发者提供项目定制生成服务。

  2. 提供快捷的模块化开发和安装方法。

  3. 开源 NeuChar.com 中的微信功能模块,可使用独立模块集成。

  4. [ ]提供完善的示例代码和文档。

  5. [ ]提供博客和视频教程(也欢迎开发者参与或发起)。

  6. [ ]提供交流社区,包括但不仅限于问答网站QQ群、微信群、直播群。

QQ 技术交流群

环境要求

  • 如使用 EFCore,则需要使用 SQL Server 2012 或以上版本数据库

如何安装

安装过程可以选择极客型命令行安装方式,或全自动一键完成。

第一步:准备数据库

确保已经安装 SQL Server 2012 及以上版本,系统登录用户具有数据库创建权限(可以不需要使用sa等账号登录),如果必须要使用账号登录,请看这里

第二步:下载源码

  1. 同步源代码到本地后,使用 Visual Studio 打开 /src/NCF.sln

第三步:自动安装

  1. Senparc.Web 项目设为启动项目,并运行,地址如:https://localhost:44311/

未初始化之前,访问首页会自动显示安装界面:

点击【立即安装】按钮:

如果您未手动执行【第二步】,系统将为您在后台自动执行相关步骤。

随后,系统将自动完成初始化安装,此时页面会提示默认管理员账号和密码,请记住这两个参数,以后将无法明文找回!

  1. 点击【点击这里登录】,使用已经保存好的管理员账号及密码进行登录:
  1. 完成登录

模块化开发

NCF 支持“即插即用”的模块化开发模式,您可以面向模块(或领域)进行开发,然后使用 NCF 对模块进行一键集成。

NCF 的扩展模块代号为 XNCF

如何加载模块?

第一步:加载 XNCF 扩展模块 dll

找到 XNCF 包并加载 dll 或 从 nuget 安装到 NCF 项目,例如我们官方的一个示例(ChangeNamespace),用于定制修改整个项目的命名空间:https://www.nuget.org/packages/Senparc.Xncf.ChangeNamespace

说明:Senparc.Xncf.ChangeNamespace 模块在 NCF 源码中已默认装载,无需从 nuget 下载。

第二步:进入管理员后台的 【扩展模块】 > 【模块管理】

此时可已经可以看到系统自动扫描到了新增模块:

第三步:点击所需安装模块的【安装按钮】,即可轻松完成模块安装

点击【安装】按钮后,自动进入到模块详情页面,大功告成!

模块默认晚装完毕后,会进入“新增待审核”的状态,点击进行开启即可。

如何使用已安装的模块?

在上一步模块详情页中,列出了当前模块支持的所有功能的列表:

为了让每个模块更加沟通安全,每一个功能都可以预先看到所有参数的透视说明

选择需要执行的方法,点击左侧【执行】按钮。例如点击“修改命名空间”功能的执行【执行】按钮:

按照提示输入对应的参数,点击【运行】按钮,即可执行此模块的此项功能。

执行完成后可以看到提示信息:

程序中所有命名空间已被批量修改:

此过程中无需编写一行代码!

如何更新模块?

您只需要引用最新的 dll(或安装 nuget 包),系统后台将自动扫描到版本更新:

【模块管理】页面

模块详情页面

点击【立即安装】即可完成新版本的升级!

如何自己开发模块?

NCF 的扩展模块代号为 XNCF,您可以在 NcfPackageSources 项目中找到我们的模块 示例项目,只需要“依葫芦画瓢”即可。后续稳定版发布之后将有完整的配套文档。

是否可以不使用模块化开发?

Q:我的系统比较简单,也不需要考虑移植、弹性或扩展,是否可以直接在 NCF 上进行开发?

A:当然可以。加载模块只是为了方便重和系统解耦用而已,NCF 适用于大多数开发场景,包括单体应用、分布式、容器、微信等移动端、跨平台 Hybrid 应用,等等。

待办事项:

  • 完善 DDD 实践
  • 添加应用商店
  • 定制命名空间
  • 发布官网及在线 Demo
  • 发布定制模板生成器(在线)
    • 可定制默认加载模块
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.

简介

NeuCharFramework Template Project 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/mrsail/NCF.git
git@gitee.com:mrsail/NCF.git
mrsail
NCF
NCF
master

搜索帮助