WebCommon类库使用说明文档
概要
WebCommon主要实现了站点与三版WebService交互的所有方法以及站点本身的（如购物车、登录处理等等）常用功能。目的是方便网站的制作，使其结构更加清晰，以提高开发效率和日后的维护工作。在使用时只需将该类库生成的DLL文件引用到对应站点，即可调用其封装好的各种功能。
结构说明
如上图所示，Comparison目录下的几个类主要用来实现游戏以及服务器之间的名称或编码的比较（目前未用）。ModelExtend目录下的主要是一些实体类，包括金币销售订单类（GoldSaleOrderInfo.cs）、付款信息类（PaymentInfo.cs）、代练订单类（PLOrderInfo.cs）和游戏服务器类（WebSiteGame.cs）。根目录下的类主要是给站点提供数据交互的方法以及处理一些业务逻辑等。下面对这些类主要功能分别作说明：
类和方法说明
﹡Basal.cs（基本方法辅助类）。
该类主要提供一些辅助方法。如格式转换、获取配置信息等。方法列举如下
1、string AppSetting(string key)
该方法提供按键值获取站点配置AppSettings接点下的实际值的功能。参数键值
（key）。返回字符串(value)。
2、DateTime ConvertDate(object @value)
该方法提供转换时间格式的功能。格式错误时将返回时间最下可能值。
3、byte ConvertByte(object @value)
该方法提供转换byte字节的功能。格式错误时将返回0。
4、bool ConvertBool(object @value)
该方法提供转换bool类型功能。格式错误时返回false。
5、int ConvertInt(object @value)
该方法提供转换int类型功能。格式错误时返回0。
6、double ConvertDouble(object @value)
该方法提供转换double类型功能。格式错误时返回0。
7、string ConvertStr(object obj)
该方法提供转换string类型功能。格式错误时返回空。
8、Guid ConvertGuid(object obj)
该方法提供转换Guid类型功能。格式错误时返回Guid.Empty。
9、string StrRandom(int length)
该方法提供生成一个随机字符串（包括大小写字母和数字）的功能。参数为需要生
成的字符串长度。返回字符串。
10、string StrLeft(string str, int length)
该方法提供从左截取字符串的功能。参数分别为需要截取的字符串和截取的长度。
返回截取后的新字符串。
11、string StrTrimLeft(string str, int length)
该方法和上一方法基本相同，只是将传入的字符串首尾空格初去后再作处理的。
12、System.Drawing.Bitmap TwistImage(Bitmap srcBmp, bool bXDir, double dMultValue, double
dPhase)
该方法提供画正弦曲线Wave扭曲图片的功能，用于画附加码背景图。参数分别表
示图片路径、图片是否扭曲、波形的幅度倍数、波形的起始相位。返回相应位图
（System.Drawing.Bitmap）。
13、string StrRandomNumber(int length)
该方法提供生成一个随机字符串（只有数字）的功能。参数为需要生成的字符串长
度。返回字符串。
14、byte[] CheckCodeCreate(out string code)
该方法提供创建随机字符以及背景图的功能。返回byte字节流和随机字符。使用
时将该字节流转换为图片（System.Drawing.Bitmap）显示出来即可。
﹡Cache.cs（站点缓存类）。
该类主要实现站点常用信息的缓存。目前缓存的信息有游戏列表、游戏实体类、第三方代码、新闻类型和汇率信息。实现机制主要是这样：在站点首次调用某种信息的时候，将该种信息保存，一分钟内，如果站点再次调用该种信息的时候，则直接从缓存取，而不用通过WebService。目前一分钟为缓存失效期，超过后则通过WebService取得，然后再缓存。主要是声明变量和属性，缓存时对其赋值，失效时将其清空，具体代码不再累赘介绍了。
﹡CahceManage.cs（站点缓存存储类）。
该类主要是用来存储缓存内容。用静态变量将语言设置、时差设置以及上一类中的具体缓存信息保存下来。语言和时差设置都是从站点的配置中读取，其他信息通过Cache.cs 类，由站点Guid与之对应（Dictionary<Guid, Cache>）而存储。
﹡DataSource.cs（站点方法类）。
该类提供站点数据交互的各种方法。列举如下：
一、站点部分
1、IList<ModelExtend.WebSiteGame> GetWebSiteGameList(Arguments.Named.WebSiteType type)
字符串长度web该方法提供从站点缓冲中获取游戏列表的功能。参数为站点类型枚举。返回游戏实
体类列表（IList<ModelExtend.WebSiteGame>）。
2、ModelExtend.WebSiteGame GetWebSiteGame(string gamecode)
该方法提供按游戏编码从站点缓冲中获取游戏实体的功能。参数为游戏编码。返回
游戏实体类（ModelExtend.WebSiteGame）。
3、ModelExtend.WebSiteGame GetWebSiteGameByName(string gamename)
功能同上一方法。参数为游戏名称。
4、IList<Model.PLGameProfession> GetGameProfessionList(string gamecode)
该方法提供获取游戏职业列表的功能。参数为游戏编码。返回职业信息列表
（IList<Model.PLGameProfession>）。
5、string GetWebSiteScriptFromCache(string typecode)
该方法提供从站点缓存中获取第三方代码或说明性文字的功能。参数为第三方代码
或说明文字的编码。返回第三方代码或说明性文字内容。
6、string GetWebSiteScript(string typecode)
该方法提供直接通过WebService获取第三方代码或说明性文字的功能。参数为第三
方代码或说明文字的编码。返回第三方代码或说明性文字内容。
7、IList<Model.SystemMoneyRate> GetRateList()
该方法提供获取汇率信息列表的功能。返回汇率信息列表
（IList<Model.SystemMoneyRate>）。
8、IList<Model.WebSiteNewsType> GetNewsTypeList()
该方法提供从站点缓存中回去新闻类型列表的功能。返回新闻信息列表
（IList<Model.WebSiteNewsType>）。
9、IList<Model.WebSiteNewsInfo> GetNewsList(string typecode)
该方法提供根据分类，获取新闻信息列表的功能。参数为新闻类型编码。返回新闻
信息列表（IList<Model.WebSiteNewsInfo>）。
10、IList<Model.WebSiteNewsInfo> GetNewsList(string typecode, int pagesize, int pagestart,
int pageend, ref int pagesum)
该方法提供根据分类，分页获取新闻信息列表的功能。参数分别为新闻类型编码、每页显示条数、起始页、当前页、总页数。返回新闻信息列表（IList<Model.WebSiteNewsInfo>）。
11、Model.WebSiteNewsInfo GetNewsInfo(Guid newsguid)
该方法提供获取单个新闻信息的功能。参数为新闻的Guid。返回该条新闻信息内容（Model.WebSiteNewsInfo）。
12、IList<Model.WebSiteVoteInfo> GetVoteList(Arguments.Named.WebSiteVoteStatus status)
该方法提供根据类型（状态）获取投票项目列表的功能。参数为投票项目类型。返回投票项目列表（IList<Model.WebSiteVoteInfo>）。
13、IList<Model.WebSiteVoteResult> GetVoteResult(Guid voteguid)
该方法提供获取投票选项列表的功能。参数为投票项目Guid。返回投票选项列表（IList<Model.WebSiteVoteResult>）。
14、bool VoteAdd(IList<Guid> resultguid)
该方法提供用户投票操作的功能。参数为投票选项Guid列表。返回bool类型。15、bool FeedbackAdd(Model.WebSiteFeedback feedback)
该方法提供用户添加意见反馈的功能。参数为站点意见反馈类（Model.WebSiteFeedback）。返回bool类型。
16、bool PaymentSet_Paypal(string content)
该方法提供Paypal付款信息设置的功能。参数为Paypal站点post过来的字符串。
返回bool类型。
17、bool PaymentSet_MoneyBooker(string content)
该方法提供MoneyBooker付款信息设置的功能。参数为MoneyBooker站点post过来的字符串。返回bool类型。
18、IList<Model.CountryInfo> GetCountryList()
该方法提供获取国家列表的功能。返回国家信息列表IList<Model.CountryInfo>。19、IList<Model.ProvinceInfo> GetProvinceList(Guid CountryGuid)
该方法提供获取省份列表的功能。参数为国家Guid。返回省份信息列表（IList<Model.ProvinceInfo>）。
20、IList<Model.CityInfo> GetCityList(Guid ProvinceGuid)
该方法提供获取城市列表的功能。参数为省份Guid。返回城市信息列表（IList<Model.CityInfo>）。
二、用户部分
1、int UserRegister(Entity.User user)
该方法提供用户注册的功能。参数为用户信息实体类（Entity.User）。返回整型数（-1：用户名存在0：未知错误1：成功）。
2、bool UserLogin
(Arguments.WebUserLoginArgs loginargs, System.Web.SessionState.HttpSessionState session) 该方法提供用户登录功能。参数为用户登录参数类和HttpSessionState对象。返回bool类型。当登录成功后会在session中增加用户信息（session.Add("__UserLogin__", obj);）。
3、Model.UserWebInfo GetUserInfo(Guid userguid)
该方法提供用户信息查询功能。参数为用户Guid。返回用户登录信息类（Model.UserWebInfo）。
4、bool UserInfoSet(Entity.User user)
该方法提供用户资料更新的功能。参数为用户实体类（Entity.User）。返回bool 类型。
5、bool UserPasswordGet(Arguments.Web.UserPasswordGet args)
该方法提供用户密码回的功能。参数为用户回密码参数类（Arguments.Web.UserPasswordGet）。返回bool类型。
6、bool UserPasswordSet(Arguments.Web.UserPasswordSet args)
该方法提供用户密码修改的功能。参数为用户密码修改参数类（Arguments.Web.UserPasswordSet）。返回bool类型。
三、金币采购部分
1、GetGoldStockUserOrderList(ref Arguments.GoldStockOrderQuery a)
该方法提供采购订单列表查询的功能。参数为采购订单查询参数类。返回采购订单信息列表（IList<Model.StockOrderInfo>）。
2、Model.StockOrderInfo GetGoldStockUserOrderInfo(Guid orderguid)
该方法采购订单查询的功能。参数为订单的Guid。返回订单信息（Model.StockOrderInfo）。
3、Model.StockValuePrice GetGoldStockProduct(string gameservercode)
该方法提供金币采购产品信息获取功能。参数为游戏服务器编码。返回采购产品信息（Model.StockValuePrice）。
4、IList<Model.ViewStockValuePrice> GetGoldStockProductList(string gamecode)
该方法提供金币采购产品信息列表获取功能。参数为游戏编码。返回金币采购产品信息列表（IList<Model.ViewStockValuePrice>）。
5、Model.StockGameInfo GetStockGameConfig(string gamecode)
该方法提供金币采购单个游戏配置获取的功能。参数为游戏编码。返回采购游戏配置信息（Model.StockGameInfo）。
6、bool GoldStockOrderAdd(Model.StockOrderInfo orderinfo)
该方法提供金币采购订单添加的功能。参数为采购订单信息（Model.StockOrderInfo ）。返回bool类型。
7、bool GoldStockOrderSentSet(Guid orderguid)
该方法提供供应商设置发货的功能。参数为订单Guid。返回bool类型。
8、IList<Model.UserWebGameServer> GoldStockUserGameServerGet(Guid userguid, string gamecode)
该方法提供获取供应商关注游戏服务器列表的功能。参数为供应商Guid和游戏编码。返回供应商关注游戏服务列表（IList<Model.UserWebGameServer>）。
9、bool GoldStockUserGameServerSet(Arguments.Web.UserGameServerSet args)
该方法提供设置供应商关注游戏服务器的功能。参数为关注服务器参数类（Arguments.Web.UserGameServerSet）。返回bool类型。
四、金币销售部分
1、Model.SaleConfig GetGoldSaleConfigInfo(string gameservercode)
该方法提供获取获取金币销售配置信息的功能。参数为游戏服务器编码。返回金币销售配置信息（Model.SaleConfig）。
2、Model.SalePriceSpecial GetGoldSaleSpecialInfo(string gameservercode)
该方法提供获取金币销售特价信息的功能。参数为游戏服务器编码。返回销售特价

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。