前言
一般在dotnet core下構(gòu)建使用web服務(wù)應(yīng)用都使用asp.net core,但通過(guò)FastHttpApi組建也可以方便地構(gòu)建web服務(wù)應(yīng)用，在FastHttpApi功能的支持下構(gòu)建多人聊天室是件非常簡(jiǎn)單的事情，通過(guò)組件并不需要了解WebSocket知識(shí)即可簡(jiǎn)單構(gòu)建，以下講解一下通過(guò)FastHttpApi如何構(gòu)建一個(gè)簡(jiǎn)單的多人聊室。
創(chuàng)建項(xiàng)目
使用FastHttpApi構(gòu)建一個(gè)WEB服務(wù)只需要?jiǎng)?chuàng)建一個(gè)普通ConsoleApp( 控制臺(tái)應(yīng)用)
創(chuàng)建項(xiàng)目后需要在Nuget中添加引用FastHttpApi
只需要簡(jiǎn)單地引用Beetlex.FastHttpApi即可構(gòu)建基于Http和Websocket通訊應(yīng)用。
創(chuàng)建邏輯
FastHttpApi對(duì)類和方法沒(méi)有太多規(guī)則約束，只需要在類上定義一個(gè)Controller標(biāo)簽即可，接下來(lái)實(shí)現(xiàn)一個(gè)簡(jiǎn)單的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() };
}
//發(fā)送聊天信息
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方法，方法的定義同樣也是沒(méi)有約束性，對(duì)于IHttpContext這些參數(shù)都是根據(jù)自己需要定義，如果不需要?jiǎng)t不用在方法中定義它。接下來(lái)的事情就是要在頁(yè)面上調(diào)用它，大家知道在頁(yè)面調(diào)用http或websocket 需要定義一些代碼和指定相應(yīng)的URL。但Beetlex.FastHttpApi提供一個(gè)非常便利的方式，通過(guò)安裝一個(gè)插件可以自動(dòng)生成這些代碼插件安裝介紹(暫只支持vs2017).當(dāng)插件安裝完成后只需要設(shè)置類文件的自定義工具即可
插件會(huì)在當(dāng)前類文下生成一個(gè)js文件，文件里把調(diào)用方法的URL和參數(shù)都定義完成
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);
}這個(gè)文件非常簡(jiǎn)單，主要包括URL，同步方法和異步方法。這個(gè)js文件需要依賴FastHttpApi.js才能使用，所以在頁(yè)面上必須把這個(gè)文件也引用上。接下來(lái)就是頁(yè)面腳本的使用
<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>引用腳本后，直接通過(guò)方法調(diào)用即可，這種明確的方法調(diào)用比傳統(tǒng)的jquery.post有著調(diào)用的明確性和便利性，讓使用者不需要查看接口文檔即可以知道方法的調(diào)用參數(shù)。如果控制器定了XML幫助注釋，插件同樣也會(huì)把注釋生成到腳本中。
靜態(tài)文件存儲(chǔ)
組件通過(guò)固定的目錄來(lái)存放靜太資源，因此項(xiàng)目需要?jiǎng)?chuàng)建一個(gè)views目錄來(lái)存儲(chǔ)靜態(tài)資源，views目錄是web服務(wù)的根目錄。
由于靜態(tài)文件默認(rèn)情況是不會(huì)被編譯處理，所以我們需要把文件設(shè)置成編譯嵌入模式或復(fù)制到輸出目錄中。如果是復(fù)制到輸出目錄下，可以在項(xiàng)目生成事件中添加一段。
啟動(dòng)服務(wù)
組件啟動(dòng)服務(wù)很簡(jiǎn)單，不過(guò)在啟動(dòng)前需要注冊(cè)一下程序集，把控制器注冊(cè)到HTTP服務(wù)中。
static void Main(string[] args)
{
mApiServer = new BeetleX.FastHttpApi.HttpApiServer();
mApiServer.Debug();//只有在Debug模式下生產(chǎn)，把靜態(tài)資源加載目錄指向項(xiàng)目的views目錄
mApiServer.Register(typeof(Program).Assembly);//加載程序集中所有控制器信息和靜態(tài)資源信息
mApiServer.Open();
Console.Write(mApiServer.BaseServer);
Console.Read();
}組件默認(rèn)是不需要配置即可啟動(dòng)HTTP服務(wù)，默認(rèn)端口是9090.不過(guò)這些信息也是可以通過(guò)配置文件加載，只要程序目錄存在HttpConfig.json文件組件即會(huì)加載配置文件中的配置信息來(lái)運(yùn)行服務(wù)。
服務(wù)配置文件
組件提供HttpConfig.json作為組件基礎(chǔ)服務(wù)項(xiàng)設(shè)置，這個(gè)文件不是必須，只要目錄下存在這個(gè)文件組件就會(huì)在初始化服務(wù)的時(shí)候加載這個(gè)文件的信息作為設(shè)置信息。以下大概的講解一下這個(gè)配置文件的配置項(xiàng)。
{
"HttpConfig": {
"Host": "",
"Port": 9090,
"SSL": false,
"CertificateFile": "",
"CertificatePassword": "",
"MaxBodyLength": 2097152,
"OutputStackTrace": false,
"StaticResurceType": "xml;svg;woff;woff2;jpg;jpeg;gif;png;js;html;htm;css;txt;ico;zip;rar",
"DefaultPage": "index.html;index.htm",
"NotLoadFolder": "\\Files;\\Images;\\Data",
"Manager": "admin",
"ManagerPWD": "123456",
"NoGzipFiles": "jpg;jpeg;png;gif;png;ico;zip;rar;bmp",
"CacheFiles": "html;htm;js;css",
"BufferSize": 1024,
"WebSocketMaxRPS": 1000,
"WriteLog": true,
"LogToConsole": true,
"LogLevel": "Warring",
"FileManager": false
}
}Host
服務(wù)監(jiān)聽的IP地址，暫只支持any或一個(gè)ip
Port
服務(wù)監(jiān)聽的端口
SSL
是否開啟SSL功能，如果需要開啟必須指定證書和加載證書的密碼；啟動(dòng)后即可對(duì)服務(wù)進(jìn)行Https訪問(wèn)
CertificateFile
證書文件
CertificatePassword
證書密碼
MaxBodyLength
Http體最大消息長(zhǎng)度，默認(rèn)是2M
OutputStackTrace
當(dāng)服務(wù)錯(cuò)誤的時(shí)候是否輸出詳細(xì)錯(cuò)誤代碼信息
StaticResurceType
支持的靜態(tài)資源類型，如果這里沒(méi)有描述的文件類型訪問(wèn)會(huì)返回403
DefaultPage
訪問(wèn)根路徑的情況，默認(rèn)尋找的文件
Manager
后臺(tái)管理員的用戶名
ManagerPWD
后臺(tái)管理員的密碼
WriteLog
是否打開日志寫文件
LogLevel
輸出日志級(jí)別,主要有以下幾種級(jí)別:Debug,None,Info,Warring,Error
這樣一個(gè)簡(jiǎn)單多人web聊天室就完成，運(yùn)行效果如下：
在線演示
詳細(xì)代碼
總結(jié)
聲明：本網(wǎng)頁(yè)內(nèi)容旨在傳播知識(shí)，若有侵權(quán)等問(wèn)題請(qǐng)及時(shí)與本網(wǎng)聯(lián)系，我們將在第一時(shí)間刪除處理。TEL:177 7030 7066 E-MAIL:11247931@qq.com
Copyright ? 2019-2025 51dongshi.com 版權(quán)所有
違法及侵權(quán)請(qǐng)聯(lián)系：TEL:177 7030 7066 E-MAIL:11247931@qq.com 本站由北京市萬(wàn)商天勤律師事務(wù)所王興未律師提供法律服務(wù)
