.net core使用FastHttpApi构建web聊天室实例代码

前言

一般在dotnet core下构建使用web服务应用都使用asp.net core,但通过FastHttpApi组建也可以方便地构建web服务应用,在FastHttpApi功能的支持下构建多人聊天室是件非常简单的事情,通过组件并不需要了解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提供一个非常便利的方式,通过安装一个插件可以自动生成这些代码插件安装介绍(暂只支持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文件组件即会加载配置文件中的配置信息来运行服务。

服务配置文件

组件提供HttpConfig.json作为组件基础服务项设置,这个文件不是必须,只要目录下存在这个文件组件就会在初始化服务的时候加载这个文件的信息作为设置信息。以下大概的讲解一下这个配置文件的配置项。

{
"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

服务监听的IP地址,暂只支持any或一个ip

Port

服务监听的端口

SSL
是否开启SSL功能,如果需要开启必须指定证书和加载证书的密码;启动后即可对服务进行Https访问

CertificateFile

证书文件

CertificatePassword

证书密码

MaxBodyLength

Http体最大消息长度,默认是2M

OutputStackTrace

当服务错误的时候是否输出详细错误代码信息

StaticResurceType

支持的静态资源类型,如果这里没有描述的文件类型访问会返回403

DefaultPage

访问根路径的情况,默认寻找的文件

Manager

后台管理员的用户名

ManagerPWD

后台管理员的密码

WriteLog

是否打开日志写文件

LogLevel

输出日志级别,主要有以下几种级别:Debug,None,Info,Warring,Error

这样一个简单多人web聊天室就完成,运行效果如下:

在线演示

详细代码

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对我们的支持。

时间: 2018-10-19

ASP.NET 使用application与session对象写的简单聊天室程序

ASP.Net中有两个重要的对象,一个是application对象,一个是session对象. Application:记录应用程序参数的对象,该对象用于共享应用程序级信息. Session:记录浏览器端的变量对象,用来存储跨网页程序程序的变量或者对象. 说实话,写了快一年的asp.net,application对象还真没怎么用过.看了看书,根据这两个对象的特性写了一个简单的聊天室程序.真的是非常的简陋. 我的思路是,有两个页面Default页和ChatRoom页,页面布局如图: Default

Asp.net使用SignalR实现聊天室的功能

一.引言 在前一篇文章<Asp.net使用SignalR实现酷炫端对端聊天功能>中,我向大家介绍了如何实现实现端对端聊天的功能的,在这一篇文章中将像大家如何使用SignalR实现群聊这样的功能. 二.实现思路 要想实现群聊的功能,首先我们需要创建一个房间,然后每个在线用户可以加入这个房间里面进行群聊,我们可以为房间设置一个唯一的名字来作为标识.那SignalR类库里面是否有这样现有的方法呢?答案是肯定的. // IGroupManager接口提供如下方法 // 作用:将连接ID加入某个组 //

ASP.NET MVC4异步聊天室的示例代码

本文介绍了ASP.NET MVC4异步聊天室的示例代码,分享给大家,具体如下: 类图: Domain层 IChatRoom.cs using System; using System.Collections.Generic; namespace MvcAsyncChat.Domain { public interface IChatRoom { void AddMessage(string message); void AddParticipant(string name); void GetM

ASP.NET网站聊天室的设计与实现(第3节)

大家都玩过网站聊天室吧,那知道它是怎么实现的吗? 今天我们就来设计一个网站聊天室,用户输入用户名登陆聊天室,采用框架结构实现. 学习内容: 第一步,聊天室首页与简单计数器设计 1.打开VS2008.在"解决方案'101'下新建网站,命名为Chatroom.默认首页文件为Default.aspx. 2.为Default.aspx添加窗体控件,切换到"设计"视图,从左侧工具箱标准组中拖出2个Lable控件,1个Textbox控件,一个Button控件,最后给输入昵称的Textbo

asp.net mvc signalr简单聊天室制作过程分析

signalr的神奇.实用很早就知道,但一直都没有亲自去试用,仅停留在文章,看了几篇简单的介绍文字,感觉还是很简单易用的. 由于最后有个项目需要使用到它,所以就决定写个小程序测试一下,实践出真知:别人写的文章,由于环境(版本等)不同,还是或多或少存在一些出入的. 环境:vs2013 / asp.net mvc 5 / signalr 2.2.1 / jquery 1.10.2 先上两个效果图: 系统会自动给加入聊天室的人员分配一个ID,是该人员的唯一标识(绿色为当前用户说的话,橙色为当前用户之外

Java continue break制作简单聊天室程序

Java continue break 制作简单聊天室程序,屏蔽不文明语言,显示每句话聊天时间 package com.swift; import java.text.SimpleDateFormat; import java.util.Date; import java.util.Scanner; public class ChatWithBreakContinue { public static void main(String[] args) { Scanner scan = new Sc

使用socket.io实现简单聊天室案例

本文实例为大家分享了socket.io实现简单聊天室的具体代码,供大家参考,具体内容如下 1.客户端[index.html]代码: <body> <h3>socket简例</h3> <hr> <div id = 'app'> <div> <div> <ul> <li v-for = 'item in msgs'> {{item.name}}说:{{item.content}} </li>

Python socket实现简单聊天室

本文实例为大家分享了Python socket实现简单聊天室的具体代码,供大家参考,具体内容如下 服务端使用了select模块,实现了对多个socket的监控.客户端由于select在Windows下只能对socket使用,所以使用了多线程来实现对客户端输入和socket连接的同时监控.注意这里的socket设置为了非阻塞.这样就实现了在一个线程中同时进行socket的接收和发送. 服务器代码: # -*- coding: utf-8 -*- import socket,select conne

python实现简单聊天室功能 可以私聊

本文实例为大家分享了python实现简单聊天室功能的具体代码,供大家参考,具体内容如下 公共模块 首先写一个公共类,用字典的形式对数据的收发,并且进行封装,导入struct解决了TCP的粘包问题,并在公共类中进行了异常处理 import socket,struct,json def send_dic(c,dic): dic_json=json.dumps(dic) dic_json_length=len(dic_json.encode('utf-8')) struct_dic_json_leng

java实现简单聊天室单人版

本文实例为大家分享了java实现简单聊天室的具体代码,供大家参考,具体内容如下 先整理下思路: 1.创建一个通信服务端,传入端口号和相关的流后等待客户端连接,并初始化图形界面. 2.创建一个JFrame,用于写出聊天的界面,这里界面名称由其他类传入. 3.把客户端创建的方法写进JFrame(当然这里很粗糙的方法) 4.设置按钮的监听事件,发送消息和离线功能 首先创建一个服务端的类 import java.io.IOException; import java.net.ServerSocket;

Python基于Socket实现简单聊天室

本文实例为大家分享了Python基于Socket实现简单聊天室,供大家参考,具体内容如下 服务端 #!/usr/bin/env python # -*- coding: utf-8 -*- # @Time : 2017/7/27 15:34 # @File : Server.py """ 聊天室服务端 """ import socket,select host='' port=7799 addr=(host,port) inputs=[] mem

Asp.net MVC SignalR来做实时Web聊天实例代码

本章和大家分享的内容是使用Signal R框架创建个简易的群聊功能,主要讲解如何在.Net的MVC中使用这个框架,由于这个项目有官方文档(当然全英文),后面也不打算写分享篇了,主要目的是让朋友们在需要使用Web实时通信的时候有更多一种解决方案,毕竟这是微软主推的一种解决方案之一. SignalR网上简介 ASP.NET SignalR 是为 ASP.NET 开发人员提供的一个库,可以简化开发人员将实时 Web 功能添加到应用程序的过程.实时 Web 功能是指这样一种功能:当所连接的客户端变得可用