開始第一個QQ機器人【適用於v1.9-v1.X】

本文轉載自查看原文 2018-09-26 08:44 2536

本示例將會使用”嚶鵡學舌”這個小插件的實現來演示如何使用Newbe.Mahua實現第一個機器人插件。

入坑提示

建議開發者先根據自身需求結合表格，選擇屬於自己的專屬開發框架，避免浪費時間。

編寫一套代碼就能在多個平台運行
支持使用除了C#之外的開發語言來開發
我希望他足夠簡單，不用學習太多就能掌握，通常只需要半個小時就能掌握所有內容
我希望社區的反饋足夠快，有問題都可以幫我解決

SDK名稱	（1）	（2）	（3）	（4）
論壇中的其他SDK	✔	✔	✔	✔
Jie2GG.Native.Csharp.Frame	✔	✘	✔	✔
Newbe.Mahua V2	✔	✔	✘	✘
Newbe.Mahua V1	✔	✘	✘	✘

論壇其他SDK的鏈接

插件功能

自動將發送者的消息回發給發送人，嚶鵡（Parrot，其實是說嚶嚶嚶怪）學舌。

基礎環境要求

Windows 操作系統
.Net Framework 4.5.2 及以上
Powershell 5.0及以上，僅開發環境要求
.Net Core SDK 2.2 及以上，僅開發環境要求

IDE

開發者可以任選以下任意一款IDE

Visual Studio 2017（VS2015 update 3 理論上也能夠開發，但開發遇到的問題，需自行解決）
Visual Studio Code
Rider（Newbe更加推薦）

設置Powershell執行策略限制

簡單來說，使用管理員權限在cmd中運行以下命令:

bash

powershell -command "Set-ExecutionPolicy RemoteSigned -Force"

參考資料：http://www.pstips.net/powershell-create-and-start-scripts.html

安裝項目模板

在安裝好 .Net Core SDK 之后，啟動控制台運行以下命令：

dotnet new -i Newbe.Mahua.Template

出現以下內容，則說明項目模板已經安裝成功。

項目模板安裝結果

新建項目

項目模板包含有五個，包含四個對應平台的模板和一個全平台的模板。

名稱	說明
newbe.mahua.all	全平台
newbe.mahua.cqp	酷 Q
newbe.mahua.mpq	MyPcQQ
newbe.mahua.qqlight	QQLight

本示例使用全平台模板 newbe.mahua.all 進行演示。

特別注意：為了確保新建的項目的能夠在所有平台運行，項目名稱至少需要包含 AAA.BBB.CCC 三段。

本次實例使用名稱 Newbe.Mahua.Plugins.Parrot 進行演示。

使用 Rider

直接使用 Rider 創建項目，可以在 Other 模板分組中找到該框架相關的模板。

使用Rider創建項目

等待 Rider 創建完畢后，進入新建的項目文件夾中。使用控制台執行更新命令，更新相應的組件包到最新：

build.bat UpdateMahuaPackages

使用其他 IDE

新建一個空的文件夾，啟動控制台，cd進入該文件夾，運行以下命令：

powershell -command "Set-ExecutionPolicy RemoteSigned -Force"

參考資料：http://www.pstips.net/powershell-create-and-start-scripts.html

安裝項目模板

在安裝好 .Net Core SDK 之后，啟動控制台運行以下命令：

dotnet new -i Newbe.Mahua.Template

出現以下內容，則說明項目模板已經安裝成功。

項目模板安裝結果

新建項目

項目模板包含有五個，包含四個對應平台的模板和一個全平台的模板。

名稱	說明
newbe.mahua.all	全平台
newbe.mahua.cqp	酷 Q
newbe.mahua.mpq	MyPcQQ
newbe.mahua.qqlight	QQLight

本示例使用全平台模板 newbe.mahua.all 進行演示。

特別注意：為了確保新建的項目的能夠在所有平台運行，項目名稱至少需要包含 AAA.BBB.CCC 三段。

本次實例使用名稱 Newbe.Mahua.Plugins.Parrot 進行演示。

使用 Rider

直接使用 Rider 創建項目，可以在 Other 模板分組中找到該框架相關的模板。

使用Rider創建項目

等待 Rider 創建完畢后，進入新建的項目文件夾中。使用控制台執行更新命令，更新相應的組件包到最新：

build.bat UpdateMahuaPackages

使用其他 IDE

新建一個空的文件夾，啟動控制台，cd進入該文件夾，運行以下命令：

REM 創建解決方案
dotnet new sln -n Newbe.Mahua.Plugins.Parrot

REM 創建項目文件夾
mkdir Newbe.Mahua.Plugins.Parrot

REM 切換目錄
cd Newbe.Mahua.Plugins.Parrot

REM 使用模板創建項目
dotnet new newbe.mahua.all -n Newbe.Mahua.Plugins.Parrot
y

REM 切換目錄
cd ../

REM 將項目添加到解決方案中
dotnet sln Newbe.Mahua.Plugins.Parrot.sln add Newbe.Mahua.Plugins.Parrot/Newbe.Mahua.Plugins.Parrot.csproj
echo finished

初次執行這些命令需要1-2分鍾時間。

具體效果如圖所示：

使用模板初始化項目

修改插件基本信息

打開PluginInfo.cs文件，按照實際需求和注釋內容進行修改。

csharp

namespace Newbe.Mahua.Plugins.Parrot { /// <summary> /// 本插件的基本信息 /// </summary> public class PluginInfo : IPluginInfo { /// <summary> /// 版本號，建議采用 主版本.次版本.修訂號 的形式 /// </summary> public string Version { get; set; } = "1.0.0"; /// <summary> /// 插件名稱 /// </summary> public string Name { get; set; } = "嚶鵡學舌"; /// <summary> /// 作者名稱 /// </summary> public string Author { get; set; } = "Newbe"; /// <summary> /// 插件Id，用於唯一標識插件產品的Id，至少包含 AAA.BBB.CCC 三個部分 /// </summary> public string Id { get; set; } = "Newbe.Mahua.Plugins.Parrot"; /// <summary> /// 插件描述 /// </summary> public string Description { get; set; } = "嚶鵡學舌，是一個使用Mahua框架開發的第一個插件。該插件實現將好友的私聊消息回發給好友的功能。"; } }

添加”接收好友消息事件”代碼實現

新建出來的項目中包含一個 ItemTemplate 文件夾，里面包含了所有需要的項模板。

注意，這個文件夾默認沒有包含到項目中，需要使用資源管理器進行查看。

將 ItemTemplate/MahuaEvent/PrivateMessageReceivedMahuaEvent.cs

文件復制到 MahuaEvents/PrivateMessageReceivedMahuaEvent.cs，並使用IDE將復制后的文件包含在項目中。

處理事件

在PrivateMessageFromFriendReceivedMahuaEvent.cs中，調用IMahuaApi，將好友消息回發給好友，實現嚶鵡學舌的效果。

csharp

using Newbe.Mahua.MahuaEvents; using System.Threading.Tasks; namespace Newbe.Mahua.Plugins.Parrot.MahuaEvents { /// <summary> /// 來自好友的私聊消息接收事件 /// </summary> public class PrivateMessageFromFriendReceivedMahuaEvent : IPrivateMessageFromFriendReceivedMahuaEvent { private readonly IMahuaApi _mahuaApi; public PrivateMessageFromFriendReceivedMahuaEvent( IMahuaApi mahuaApi) { _mahuaApi = mahuaApi; } public void ProcessFriendMessage(PrivateMessageFromFriendReceivedContext context) { // 戳一戳 _mahuaApi.SendPrivateMessage(context.FromQq) .Shake() .Done(); // 嚶嚶嚶，換行，重復消息 _mahuaApi.SendPrivateMessage(context.FromQq) .Text("嚶嚶嚶：") .Newline() .Text(context.Message) .Done(); // 異步發送消息，不能使用 _mahuaApi 實例，需要另外開啟Session Task.Factory.StartNew(() => { using (var robotSession = MahuaRobotManager.Instance.CreateSession()) { var api = robotSession.MahuaApi; api.SendPrivateMessage(context.FromQq, "異步的嚶嚶嚶"); } }); } } }

在模塊中注冊事件

打開MahuaModule.cs文件，在MahuaEventsModule中注冊剛剛添加的PrivateMessageFromFriendReceivedMahuaEvent。

csharp

using Autofac; using Newbe.Mahua.MahuaEvents; using Newbe.Mahua.Plugins.Parrot.MahuaEvents; namespace Newbe.Mahua.Plugins.Parrot { /// <summary> /// Ioc容器注冊 /// </summary> public class MahuaModule : IMahuaModule { public Module[] GetModules() { // 可以按照功能模塊進行划分，此處可以改造為基於文件配置進行構造。實現模塊化編程。 return new Module[] { new PluginModule(), new MahuaEventsModule(), }; } /// <summary> /// 基本模塊 /// </summary> private class PluginModule : Module { protected override void Load(ContainerBuilder builder) { base.Load(builder); // 將實現類與接口的關系注入到Autofac的Ioc容器中。如果此處缺少注冊將無法啟動插件。 // 注意！！！PluginInfo是插件運行必須注冊的，其他內容則不是必要的！！！ builder.RegisterType<PluginInfo>() .As<IPluginInfo>(); } } /// <summary> /// <see cref="IMahuaEvent"/> 事件處理模塊 /// </summary> private class MahuaEventsModule : Module { protected override void Load(ContainerBuilder builder) { base.Load(builder); // 將需要監聽的事件注冊，若缺少此注冊，則不會調用相關的實現類 builder.RegisterType<PrivateMessageFromFriendReceivedMahuaEvent>() .As<IPrivateMessageFromFriendReceivedMahuaEvent>(); } } } }