一般在dotnet core
下構建使用web服務應用都使用asp.net core,但通過FastHttpApi
組建也可以方便地構建web服務應用,在FastHttpApi
功能的支持下構建多人聊天室是件非常簡單的事情,通過組件並不需要了解WebSocket知識即可簡單構建,以下講解一下通過FastHttpApi如何構建一個簡單的多人聊室。
創建項目
使用FastHttpApi構建一個WEB服務只需要創建一個普通ConsoleApp( 控制檯應用)
創建項目後需要在Nuget
中添加引用FastHttpApi
只需要簡單地引用Beetlex.FastHttpApi
即可構建基於Http
和Websocket
通訊應用。
創建邏輯
FastHttpApi對類和方法沒有太多規則約束,只需要在類上定義一個Controller
標籤即可,接下來實現一個簡單的發送消息方法
[Controller]
public class Controller
{
public bool Talk(string name, string messge, IHttpContext context)
{
ActionResult result = new ActionResult();
result.Data = new { name, messge };
context.SendToWebSocket(result);
return true;
}
}
以上代碼定義一個Talk方法,方法把發信息的暱稱和消息發送當前服務上下文中的所有websocket連接。直接下來的事情就是要在頁面上調用它,大家知道在頁面調用http或websocket 需要定義一些代碼和指定相應的URL。但Beetlex.FastHttpApi
提供一個非常便利的方式,通過安裝一個插件可以自動生成這些代碼插件安裝介紹(暫只支持vs2017).當插件安裝完成後只需要設置類文件的自定義工具即可
插件會在當前類文下生成一個js
文件,文件裏把調用方法的URL和參數都定義完成
var $Talk$url='/talk';
function $Talk(name,messge,useHttp)
{
return api($Talk$url,{name:name,messge:messge},useHttp).sync();
}
function $Talk$async(name,messge,useHttp)
{
return api($Talk$url,{name:name,messge:messge},useHttp);
}
這個文件非常簡單,主要包括URL,同步方法和異步方法。這個js
文件需要依賴FastHttpApi.js
才能使用,所以在頁面上必須把這個文件也引用上。接下來就是頁面腳本的使用
<script>
function onreceive(result) {
$('<p><span class="label label-default">' + result.Data.name+'</span>:' + result.Data.messge + '</p>').appendTo('#lstTalk')
}
async function sendMessage() {
var name = $('#name').val();
var message = $('#msg').val();
if (!name) {
alert("enter name!");
return;
}
if (!message) {
alert('enter messgae');
return;
}
var result = await $Talk(name, message);
if (result.Code != 200) {
alert(result.Error);
}
else
$('#msg').val('');
}
$(document).ready(function () {
api_receive(onreceive);//綁定消息接收事件
});
</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聊天室就完成,運行效果如下: