侠客云SDK 模块开发入门教程

admin

SDK客户端所有组件源码都是开放的，所以二次开发能实现任何您需要的功能，包括界面修改、软件功能、模块开发、授权系统开发等。

如果您不会编程，没有C#编程基础，您可以联系官方技术支持，我们将根据您的需求为您量身定制任意功能。

如果您有C#编程基础，按照以下步骤，您可以快速获取官方提供的SDK源代码并进行二次开发和使用，也可以基于SDK的模块系统制作自己的独立模块，同时开发过程中遇到任何问题都可以随时联系我们或在讨论组发帖快速获取在线技术支持服务。

本文主要讲解如何快速建立自定义功能模块，该方法无需修改编译SDK即可创建可以被SDK模块系统加载并运行的第三方独立模块。模块完整项目可从底部附件中下载。

第一步：配置开发环境。

操作系统要求：windows7 64位以上

SDK模块需要C#编程语言编写，该编程语言适合新手入门。模块的编写和编译需要在Visual Studio中进行，推荐使用Visual Studio 2017及以上版本。 Visual Studio最新版本可以直接从 https://visualstudio.microsoft.com/zh-hans/downloads/ 下载，建议下载免费社区版，免费试用30天，注册微软账号即可永久免费使用。

下载完成后运行安装，选择安装.NET桌面开发组件和NET Framework 4.6.1 目标包，勾选完成后点击安装即可。

安装完成后，运行Visual Studio，点击文件》》新建项目，若有以下选项即为组件安装成功，否则安装失败需要重新运行安装包并勾选需要安装的组件。

第二步：安装SDK并接入测试设备。

参考 快速下载安装、接入设备教程 下载SDK主程序，申请免费授权码，架设节点服务器，接入设备。

第三步：创建模块项目。

打开Visual Studio，点击文件》》新建项目，新建一个C#类库。

注意：项目类型必须选择 类库(.Net Framework)， 框架必须选择 .Net Framework 4.6.1。

在项目上鼠标右键》》添加》》引用。

点击浏览，选择SDK主程序目录中的“Xky.Core.dll”。然后点击添加》》确定，将“Xky.Core.dll”引用到项目中。

第四步：编写模块代码。

上面的步骤只是新建了一个普通的C#类库，继承“Xky.Core.dll”中的的“XModule”类，实现其中成员才可以被SDK主程序加载和调用。

修改代码，继成XModule，根据提示实现其所有成员，最终代码如下：

1. using System;
   5 v' }2 V0 e' f3 O% A8 V
2. using System.Collections.Generic;
   
3. using System.Linq;
   $ _4 G# ]* C6 R  R0 Z
4. using System.Text;
   
5. using System.Threading.Tasks;
   
6. 
     v* u( _0 l" m/ A' y
7. namespace TestModule
   
8. {
   
9.     public class Test : Xky.Core.XModule
   
10.     {
    
11.         public override string Description()
    . S  U! V' T' }: i
12.         {
    ! Y  U7 |$ G8 W
13.             return "模块描述";
    
14.         }
    
15. 
    0 T* `5 x+ z" l" B" T9 O* r% t
16.         public override byte[] Icon()
    9 U  z& ]$ z" I  U
17.         {
    ; |& T5 U# H: K0 ~) P8 F5 |, u. Z7 A3 N
18.             throw new NotImplementedException();
    
19.         }
    
20. 
    6 v. u0 I+ {/ ~: m% V+ A$ [
21.         public override bool IsBackground()
    / u" u! A) Y7 ~" h" t( [9 l9 q
22.         {
    
23.             return true;
    9 o' n$ p! I2 h, d# T: u& e" _; [
24.         }
    
25. 
    9 j7 R! i% ~) t1 w2 b! r
26.         public override string Name()
    / H& _/ K7 C. w+ X  S3 Y
27.         {
    2 c7 O7 F# {2 T$ m9 h$ q4 m/ w" Y% t9 l
28.             return "模块名称";
    
29.         }
    
30. 
    7 q( C! ]- A% ^$ ^( U* {
31.         public override void Start()
    $ |: D) }0 `; ]9 \
32.         {
    
33.             Device.ScriptEngine.Toast("提示内容");
    ; F* `& D% x# s; ?
34.         }
    
35.     }
    7 a1 {- x' r3 ?/ T
36. }
    

复制代码

由于模块需要设置图标，准备一张正方形（推荐尺寸128*128像素）jpg或png图片，鼠标右键复制然后在项目上右键粘贴。在图片上右键》》属性，将生成操作改为“嵌入的资源”。修改模块代码，读取该图片作为模块图标。

1. using System;
   ( w6 i4 u$ t% d) N- @7 H0 I3 r0 ~
2. using System.Collections.Generic;
   ; N2 U! T' S$ c: E5 B2 Y, Q
3. using System.IO;
   
4. using System.Linq;
   , U" X* k7 H1 `/ f- u; b
5. using System.Reflection;
   
6. using System.Text;
   / E/ _6 X+ W1 L6 L) M0 O  Q
7. using System.Threading.Tasks;
   
8. 
   : B9 l( V. B; J' G6 P
9. namespace TestModule
   6 l* [1 E0 t; \1 d1 g; Z( L0 V
10. {
    
11.     public class Test : Xky.Core.XModule
    4 l  s4 K4 }; t) f' R" z' j' G
12.     {
    
13.         public override string Description()
    
14.         {
    & K( @1 K% l2 A6 p" a) F
15.             return "模块描述";
    
16.         }
    . \& I& L5 z: e6 E" ?
17. 
    
18.         public override byte[] Icon()
    
19.         {
    $ T+ r5 ]7 |. a
20.             Assembly myAssembly = Assembly.GetExecutingAssembly();
    
21.             //注意：路径参数必须和当前模块命名空间一致
    
22.             Stream myStream = myAssembly.GetManifestResourceStream("TestModule.icon.png");
    ; h( ?9 @* q3 ~" X
23.             if (myStream != null)
    8 x% ?0 C: j' ]
24.             {
    
25.                 byte[] bytes = new byte[myStream.Length];
      L" W; q& J  C! [
26.                 myStream.Read(bytes, 0, bytes.Length);
    3 }# n- R  M; k2 @4 u( j
27.                 return bytes;
    $ O$ _- y9 \; z
28.             }
    & l- A, @9 R4 ~7 z" ^+ K
29.             else
    
30.             {
    
31.                 Console.WriteLine("模块图标路径有误，无法加载！");
    
32.                 return null;
    0 A# k7 p' w- k
33.             }
    % J! [5 [0 c* ?3 v. w
34.         }
    
35. 
    
36.         public override bool IsBackground()
    
37.         {
    + Q$ j& J3 h7 w( P2 g
38.             return true;
    
39.         }
    
40. 
    
41.         public override string Name()
    
42.         {
    4 N8 k0 ], N7 w4 ?7 f
43.             return "模块名称";
    # e! X! C% ]4 B% @+ W* W9 G
44.         }
    # ~, w6 o2 `5 n2 u( Y
45. 
    
46.         public override void Start()
    6 j/ I) V% N: e! w/ H5 U
47.         {
    
48.             Device.ScriptEngine.Toast("提示内容");
    7 N. p) u2 y) S) T* _
49.         }
    $ E/ }; O( V' ^: v6 S; w. ^, O
50.     }
    * e( w7 R6 A  k' G5 n/ J
51. }
    " s& W2 `& ^# l& t1 G  w

复制代码

第五步：生成并运行模块。

在项目上鼠标右键》》属性，将程序集名称和默认命名空间都设置为跟模块代码中的命名空间一样

注意：项目属性的程序集名称、默认命名空间和模块代码中的命名空间、加载图标的路径参数必须一致，否则模块将无法被SDK加载。

在项目上鼠标右键》》重新生成，生成完毕后即可在项目的bin>>debug目录下看到生成出来的模块dll文件。

回到SDK主程序目录的Modules文件夹中，新建一个分组文件夹，例如“我的模块”。进入“我的模块”文件夹，再次建立一个文件夹用来存放模块dll，例如“测试模块”，并将生成的模块dll文件复制到该目录中。

完成以上操作后，重新启动SDK主程序，即可在右侧的模块面板中看到自己的分组和模块，双击或点击运行即可运行该模块。

如果不想每次修改模块代码重新生成以后都要手动复制到SDK模块目录中，我们可以为模块项目设置生成事件，每次生成成功以后自动复制模块文件到SDK模块目录中。 在模块项目上右键》》属性》》生成事件，设置后期生成事件命令，格式为“xcopy $(TargetPath) 模块文件存放的目录 /y”(注意空格)

xcopy $(TargetPath) G:\xky\Xky.Platform\bin\Release\Modules\我的模块\测试模块\ /y

这样设置以后，每次修改模块代码，只需要在项目上鼠标右键》》重新生成，然后重启SDK即可直接加载最新模块。

简单模块代码全部写在Start()方法中，更多API接口和示例可参考 侠客云SDK开发文档 ，更多模块示例或带界面交互功能的模块可参考SDK模块示例源码。

https://static.xky.com/topic/files/4_1559633786252.zip