.net core下使用FastHttpApi構建web聊天室

摘要： 一般在 dotnet core 下構建使用web服務應用都使用asp.net core,但通過 FastHttpApi 組建也可以方便地構建web服務應用，在 FastHttpApi 功能的支援下構建多人聊天室是件非常簡單的事情，通過元件並不需要了解WebSocket知識即可簡單構建，以下講...

一般在 dotnet core 下構建使用web服務應用都使用asp.net core,但通過 FastHttpApi 組建也可以方便地構建web服務應用，在 FastHttpApi 功能的支援下構建多人聊天室是件非常簡單的事情，通過元件並不需要了解Socket/">WebSocket知識即可簡單構建，以下講解一下通過FastHttpApi如何構建一個簡單的多人聊室。

建立專案

使用FastHttpApi構建一個WEB服務只需要建立一個普通 ConsoleApp( 控制檯應用)

建立專案後需要在 Nuget 中新增引用 FastHttpApi

只需要簡單地引用 Beetlex.FastHttpApi 即可構建基於 Http 和 Websocket 通訊應用。

建立邏輯

FastHttpApi對類和方法沒有太多規則約束，只需要在類上定義一個 Controller 標籤即可，接下來實現一個簡單的web聊天室

[Controller]
public class Controller
{
//使用者登陸
public bool Login(string nickName, IHttpContext context)
{
context.Session.Name = nickName;
ActionResult result = new ActionResult();
result.Data = new { name = nickName, message = "login", type = "login", time = DateTime.Now.ToString("T") };
context.SendToWebSocket(result);
return true;
}
//獲取線上使用者
public object ListOnlines(IHttpContext context)
{
return from r in context.Server.GetWebSockets()
where r.Session.Name != null
select new { r.Session.Name, IP = r.Session.RemoteEndPoint.ToString() };
}

//傳送聊天資訊
public bool Talk(string nickName, string message, IHttpContext context)
{
ActionResult result = new ActionResult();
result.Data = new { name = nickName, message, type = "talk", time = DateTime.Now.ToString("T") };
context.SendToWebSocket(result);
return true;
}
}

以上程式碼分別定義登陸，獲取線上使用者和alk方法，方法的定義同樣也是沒有約束性，對於 IHttpContext 這些引數都是根據自己需要定義，如果不需要則不用在方法中定義它。接下來的事情就是要在頁面上呼叫它，大家知道在頁面呼叫http或websocket 需要定義一些程式碼和指定相應的URL。但 Beetlex.FastHttpApi 提供一個非常便利的方式，通過安裝一個外掛可以自動生成這些程式碼 ofollow,noindex" target="_blank"> 外掛安裝介紹(暫只支援vs2017) .當外掛安裝完成後只需要設定類檔案的 自定義工具即可

外掛會在當前類文下生成一個 js 檔案，檔案裡把呼叫方法的URL和引數都定義完成

var $Login$url='/login';
function $Login(nickName,useHttp)
{
return api($Login$url,{nickName:nickName},useHttp).sync();
}
function $Login$async(nickName,useHttp)
{
return api($Login$url,{nickName:nickName},useHttp);
}
var $ListOnlines$url='/listonlines';
function $ListOnlines(useHttp)
{
return api($ListOnlines$url,{},useHttp).sync();
}
function $ListOnlines$async(useHttp)
{
return api($ListOnlines$url,{},useHttp);
}
var $Talk$url='/talk';
function $Talk(nickName,message,useHttp)
{
return api($Talk$url,{nickName:nickName,message:message},useHttp).sync();
}
function $Talk$async(nickName,message,useHttp)
{
return api($Talk$url,{nickName:nickName,message:message},useHttp);
}

這個檔案非常簡單，主要包括URL，同步方法和非同步方法。這個 js 檔案需要依賴 FastHttpApi.js 才能使用，所以在頁面上必須把這個檔案也引用上。接下來就是頁面指令碼的使用

<script>
function receive(result) {
if (result.Data.type == 'login' || result.Data.type == 'quit') {
$ListOnlines$async().execute(function (result) {
listUserControl.Data = result.Data;
});
}
messages.push(result.Data);
var objDiv = document.getElementById("lstTalk");
objDiv.scrollTop = objDiv.scrollHeight;
}

async function sendMessage() {
var msg = $('#talkMsg').val();
if (!msg) {
alert("enter message");
return;
}

var result = await $Talk(nickName, msg);
if (result.Code != 200)
alert(result.Error);
else
$('#talkMsg').val('');

}
async function login() {
nickName = $('#userName').val();
if (!nickName) {
alert("enter you name!")
return;
}
var result = await $Login(nickName);
if (result.Code == 200) {
$('#loginBar').hide();
$('#talkBar').show();
}
else {
alert(result.Error);
}
}
</script>

引用指令碼後，直接通過方法呼叫即可，這種明確的方法呼叫比傳統的 jquery.post 有著呼叫的明確性和便利性，讓使用者不需要檢視介面文件即可以知道方法的呼叫引數。如果控制器定了XML幫助註釋，外掛同樣也會把註釋生成到指令碼中。

靜態檔案儲存

元件通過固定的目錄來存放靜太資源，因此專案需要建立一個 views 目錄來儲存靜態資源， views 目錄是web服務的根目錄。

由於靜態檔案預設情況是不會被編譯處理，所以我們需要把檔案設定成編譯嵌入模式或複製到輸出目錄中。如果是複製到輸出目錄下，可以在專案生成事件中新增一段複製程式碼。

啟動服務

元件啟動服務很簡單，不過在啟動前需要註冊一下程式集，把控制器註冊到HTTP服務中。

static void Main(string[] args)
{
mApiServer = new BeetleX.FastHttpApi.HttpApiServer();
mApiServer.Debug();//只有在Debug模式下生產，把靜態資源載入目錄指向專案的views目錄
mApiServer.Register(typeof(Program).Assembly);//載入程式集中所有控制器資訊和靜態資源資訊
mApiServer.Open();
Console.Write(mApiServer.BaseServer);
Console.Read();
}

元件預設是不需要配置即可啟動HTTP服務，預設埠是 9090 .不過這些資訊也是可以通過配置檔案載入，只要程式目錄存在 HttpConfig.json 檔案元件即會載入配置檔案中的配置資訊來執行服務。 配置檔案詳解

這樣一個簡單多人web聊天室就完成，執行效果如下：

線上演示

詳細程式碼