2 Star 1 Fork 0

cpjit / choper-elk

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

choper-elk

choper-elk 是一个“集实现IOC容器与支持WCF多种协议”WCF服务容器的框架。

将你的服务全权交由choper-elk托管,通过配置切换框架对WebHttpBinding、BasicHttpBinding、TCPBinding三种协议的切换和支持。内置的IOC可让你的工程的各个模块解耦,就像Java的程序员使用Spring-Framework一样,添加一系列特性(就像Java的注解)即可完成实例注入。

目录

一. 工程结构说明

二. 加入依赖的动态链接库

三. 快速搭建一个支持REST调用的WCF服务

四. 核心API

五. 更新日志

六. 示例程序

一. 工程结构说明

Choper.Elk ······································· Elk的WCF服务容器、以及IOC容器。

Choper.Elk.Buckhorn ·························· Elk公共特性、公共异常、公共枚举等。

Choper.Elk.Test.Contract ····················· 测试用。测试工程的WCF接口协议。

Choper.Elk.Test.BLL ··························· 测试用。测试工程的业务逻辑层。

Choper.Elk.Test.DAL ··························· 测试用。测试工程的数据访问层。

Choper.Elk.Test.Model ························ 测试用。测试工程的实体。

二. 加入依赖的动态链接库

  1. 引用CPJIT.Library.CPJ4net.dll。你也可以从 https://github.com/sunnypaine/cpj4net 上面下载。当然,既然依赖了此工具包,CPJIT.Library.CPJ4net.dll所依赖的一堆包也是需要的。

  2. 工程只需要引用上面的CPJIT.Library.CPJ4net.dll就够了,CPJIT.Library.CPJ4net.dll所依赖的那些dll可以不引用到工程中,只需要在可执行文件夹下存在就可以了。除非你的工程中也需要使用到那些包。

三. 快速搭建一个支持REST调用的WCF服务

第一步 检查Choper.Elk.exe.config文件的配置信息是否如下:

<?xml version="1.0" encoding="utf-8">
<configuration>
    <startup>
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" />
    </startup>

    <runtime>
        <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
            <probing privatePath="business"/>
        </assemblyBinding>
    </runtime>

    <appSettings>
        <add key="ip" value="127.0.0.1"/> <!--你的服务所在计算机的IP,可修改-->
        <add key="port" value="9999"/> <!--你的服务的端口,可修改-->
        <add key="version" value="V1.0.0.0"/> <!--你的服务版本-->
    </appSettings>
</configuration>

第二步 检查application.properties文件。

该文件是choper-elk框架的专属配置文件,必须有,如果没有会给你报错。此配置文件的配置信息填写方法和Java的spring-boot的application.properties一样,就是最易理解的键值对,该配置文件的配置信息将与ConfigurationAttribute的ValueAttribute特性配合使用,Elk框架将会自动把这些配置信息注入到Value特性标识的私有变量中,后面会有说明。示例如下:

mysql.url=jdbc:mysql://127.0.0.1:3306/zdszhzh
mysql.driver-class-name=com.mysql.jdbc.Driver
mysql.username=szhzh
mysql.password=123456

activemq.url=tcp://127.0.0.1:61616
activemq.username=admin
activemq.password=admin

第三步 检查可执行程序目录下是否存在business文件夹。当然,如果该文件夹不存在,框架将自动创建。该文件夹的作用是存放用户开发的WCF服务业务dll文件。

第四步 写一个简单的WCF协议接口。示例如下:

//定义WCF协议接口
[ServiceContract(Namespace = "http://www.choper.org")]
public interface IUserContarct
{
  [OperationContract]
  [WebInvoke(Method = "GET",
            UriTemplate = "/User/{id}",
            RequestFormat = WebMessageFormat.Json,
            ResponseFormat = WebMessageFormat.Json)]
  [return: MessageParameter(Name = "User")]
  User QueryUserById(string id);
}

//实现协议服务
[Contract("userContract")]
public class UserContractImpl : IUserContract
{
    public User QueryUserById(string id)
  {
      //TODO
  }
}

将你的工程编译后的dll放到business文件夹下,

双击Choper.Elk.exe,服务就成功跑起来了。

访问WCF服务地址:http://127.0.0.1:9999/api/v1.0.0.0/UserContract/User/001 ,就可以访问到QueryUserById这个WCF协议接口了。

四. 核心API

1. ConfigurationAttribute特性

说明 该特性作用于类上。当类上做了该特性标识,则标识该类是一个用于做配置信息的类。

示例 

[Configuration("activemqConfig")]
public ActivemqConfig
{ }

2. DataAccessAttribute特性

说明 该特性作用于类上。当类上做了该特性标识,则标识该类是一个数据访问层的类。

示例 

[DataAccess("userDataAccess")]
public class UserDataAccessImpl : IUserDataAccess
{ }

3. BusinessAttribute特性

说明 该特性作用于类上。当类上做了该特性标识,则标识该类是一个业务逻辑层的类。

示例 

[Business("userBusiness")]
public class UserBusinessImpl : IUserBusiness
{ }

4. ContractAttribute特性

说明 该特性作用于类上。当类上做了该特性标识,则标识该类是一个WCF协议实现的类。

示例 

[Contract]
public class UserContractImpl : IUserContract
{ }

5. ValueAttribute特性

说明 该特性作用于私有变量上。当私有变量做了该特性标识,则choper-elk框架将自动从application.propertie配置文件中读取配置信息并注入对应的私有变量中。

注意 只有当类标识了ConfigurationAttribute特性时,类中标识了ValueAttribute特性的私有变量才会被扫描并赋值。

示例 

[Configuration("activemqConfig")]
public class ActivemqConfig
{
  [Value(Name = "activemq.url")]
  private string url;
  
  [Value(Name = "activemq.username")]
  private string userName;
  
  [Value(Name = "activemq.password")]
  private string password;
}

6. BeanAttribute特性

说明 该特性作用于方法上。当方法上做了该特性标识,则choper-elk框架将自动执行该方法。

注意 标识了该特性的方法必须要有返回值。

示例 

[Configuration("activemqConfig")]
public class ActivemqConfig
{
  [Bean(Name = "activemqConnectionFactory")]
  public IConnectionFacotry ActiveMQConnectionFacotry()
  {
    ConnectionFactory factory = new ConnectionFactory();
    factory.CientId = "ActiveMQ测试客户端";
    return factory;
  }
}

7. ParameterAttribute特性

说明 该特性作用于方法的参数上。当参数做了该特性标识,则choper-elk框架将自动为该参数注入值。

示例 

[Configuration("activemqConfig")]
public class AcitvemqConfig
{
  [Bean(Name = "activemqConnectionFactory")]
  public IConnectionFacotry ActiveMQConnectionFacotry()
  {
    ConnectionFactory factory = new ConnectionFactory();
    factory.CientId = "ActiveMQ测试客户端";
    return factory;
  }
  
  [Bean(Name = "activemqConnection")]
  public IConnection ActiveMQConnection([Parameter("activemqConnectionFactory")] ConnectionFactory connectionFactory)
  {
    IConnection connection = null;
    try
    {
      connection = connectionFactory.CreateConnection();
      connection.Start();
    }
    catch(Exception e)
    {
      Console.WriteLine(e.Message);
    }
    return connection;
  }
}

8. ResourceAttribute特性

说明 该特性作用于私有变量上。当私有变量做了该特性标识,则choper-elk框架将会为其自动注入值。

注意 只有当类标识了DataAccessAttribute特性、或BusinessAttribute特性、或ContractAttribute特性时,类中的标识了ResourceAttribute特性的私有变量才会被自动注入。

示例 

[Business("userBusiness")]
public UserBusinessImpl : IUserBusiness
{
	[Resource(Name = "userDataAccess")]
  private IUserDataAccess userDataAccess;
  
  public User FindUserById(string userId)
  {
  	if (string.IsNullOrEmpty(userId))
    {
    	return null;
    }
  	return this.userDataAccess.SelectUserById(userId);
  }
}

五. 更新日志

2018.05.22_ 首次发布[v1.0.0.0]。

六. 示例程序

示例程序见工程中Choper.Elk.Test开头的工程。第一章 工程结构说明 有详细说明。

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.

简介

一个“集实现IOC容器与支持WCF多种协议”WCF服务容器的框架。 展开 收起
C#
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
C#
1
https://gitee.com/cpjit/choper-elk.git
git@gitee.com:cpjit/choper-elk.git
cpjit
choper-elk
choper-elk
master

搜索帮助