Asp.net（二）营业处置惩罚接口项目（Web Api）【C#.Net教程】,Asp.net,Web Api,接口

简介

Api作为营业逻辑供应方，承载了项目的中心逻辑，因此具有相对高的逻辑复杂性。在如许的前提下怎样简化代码编写，怎样范例一致誊写作风和逻辑范例，怎样进步代码的保护性和扩展性。项目的搭建的高内聚低耦合变得主要。
示例的是一个企业级项目，框架图以下

api层.jpg

Security：重写了Http请求（Override DelegatingHandler），在请求的切面举行合法性推断，趁便举行署名请求的预处置惩罚。
Client：定义了一致的接口挪用体式格局共挪用端运用，简化及一致了接口运用。
Ctrl层：作为效劳的直接供应方，在效劳器上直接供应类似于RestFul作风的接口（觉得严厉的RestFul作风，须要有完整的范畴模子驱动，现实上的状况老是不尽善尽美，范畴笼统才能不够。），猎取请求数据，按需挪用Filter过滤器，进一步推断，挪用
Model层：作为营业模子层，供应营业逻辑的现实操纵。运用一致的实体模子，并联络到Ibatis上，举行数据操纵。
细致的代码构造以下图：

Api-UML.jpg

下面是各个模块的细致引见和代码示例：

Entity library项目代码示例

项目构造以下图：

entity.jpg

Domain模块，作为实体模子，浅易代码以下

public class User
{
      public int Id { get; set; }
      public string NickName { get; set; }
      public string Avatar { get; set; }
}

Request，请求构造模子，应用了泛型接口，将请求类和返回类联络，起到了掌握倒转的作用。

public abstract class AbstractRequest
{
    public bool ValidateParameters()
    {
        //公用要领示例，考证参数合法性
    }
}
   public interface IRequest<T> where T:AbstractResponse
    {
        //猎取接口称号
        string GetApiName();

        //猎取接口编码
        string GetApiCode();
    }
//猎取User信息的请求构造定义
  public class GetUserRequest:AbstractRequest,IRequest<GetUserResponse>
    {
        public int Id { get; set; }

        public string GetApiName()
        {
            return "User.GetUserDetail";
        }

        public string GetApiCode()
        {
            return "User001";
        }
    }

Response模块，作为请求的返回范例，定义一致的返回构造，便于消费者举行一致性返回码推断处置惩罚。

public abstract class AbstractResponse
    {
        //返回码
        public int Code { get; set; }
        //报错信息
        public string Message { get; set; }
    }
 public class GetUserResponse:AbstractResponse
    {
        public User User { get; set; }
    }

Service项目代码示例

项目构造以下图：

service.jpg

代码示例：

 public interface IUserService
    {
        GetUserResponse GetUser(int id);
    }
 public class BaseService
    {
        //protected SqlInstance sqlInstance;
        public BaseService()
        {
            //sqlInstance=new SqlInstance(); //实例化数据库衔接
            //...
        }
        //...
    }
  public class UserService:BaseService,IUserService
    {
        public GetUserResponse GetUser(int id)
        {
            //链接数据库猎取数据
            //...
            throw new NotImplementedException();
        }
    }

Security类库代码示例

类库只是处置惩罚了平安性题目，在api请求进口处增加上权限推断。运用重写Http请求的体式格局。
代码示例

public class MyHandler : DelegatingHandler
    {
        protected async override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
        {
            IEnumerable<string> keyEnumerable;
            var t1 = request.Headers.TryGetValues("key", out keyEnumerable);
            var key = keyEnumerable.FirstOrDefault();
            if (!true)//考证类似于token的权限
            {
                return await Task.Factory.StartNew<HttpResponseMessage>(
                            () => new HttpResponseMessage(HttpStatusCode.Forbidden)
                            {
                                Content = new StringContent("error message")
                            });
            }
            //如果有signature，推断，并加效果标志，没有的话，消灭signature相干信息，防备捏造。
            //.....
            return await base.SendAsync(request, cancellationToken);
        }
    }

笼统出来的权限推断，可直接挪用到webapi端，增加到路由设置代码中。

WebApi项目示例

作为接口的现实定义，webapi定义了接口文件的现实划定规矩，并做出相应的平安治理及接口的权限掌握。进修微信的权限掌握，也许肯定了几种接口：

接口权限.png

这些权限的推断都放在了Security做了集合治理。接口定义只须要在相应的逻辑上运用推断合法性即可。
代码示例：

public class UserController : ApiController
    {
        private IUserService userService;

        public UserController()
        {
            userService=new UserService();
        }

        [Signature]//平安署名过滤器推断
        [HttpPost]
        public GetUserResponse GetUser(GetUserRequest request)
        {
            //参数推断，平安性推断等等
            var ret = userService.GetUser(request.Id);
            return ret;
        }

    }

以上是一个猎取用户信息的示例接口，而作为接口进口的路由设置，则须要对请求的合法性举行推断，路由设置代码以下：

public static void Register(HttpConfiguration config)
{
            // Web API configuration and services
            // Configure Web API to use only bearer token authentication.
            config.SuppressDefaultHostAuthentication();
            config.Filters.Add(new HostAuthenticationFilter(OAuthDefaults.AuthenticationType));

            // Web API routes
            config.MapHttpAttributeRoutes();

            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/{controller}/{action}",
                defaults: new { id = RouteParameter.Optional }
            );
            //增加的代码，增加http请求的进口处置惩罚
            config.MessageHandlers.Add(new MyHandler());
}

Client类库代码示例

Client类库定义了接口挪用的大众要领。
1、应用泛型接口，将请求类和返回类举行了封装，简化挪用的代码誊写。
2、并使得消费者挪用接口须要经由过程代办类，避开了跨域的题目。
3、消费者的挪用都赞同运用一致类库，是的日记的处置惩罚一致，返回的毛病也能够举行一致化定义。
代码示例以下：

 public interface IClient
 {
     T Execute<T>(IRequest<T> request) where T : AbstractResponse;
 }

public class DefaultClient:IClient
    {
        private readonly string appKey;
        private readonly string appSecret;
        private readonly string baseUrl = "http://localhost:16469/api/";
        private readonly bool isNeedLogFile = false;
        private readonly LogFile logFile;
        public static readonly string SecureHeaderAppKey = "secure_head_appkey";
        public static readonly string SecureHeaderSignature = "secure_head_signature";

        public DefaultClient()
        {
            baseUrl = ConfigurationManager.AppSettings["service_base_url"];
            appKey = ConfigurationManager.AppSettings["app_key"];
            appSecret = ConfigurationManager.AppSettings["app_secret"];
            isNeedLogFile = "1".Equals(ConfigurationManager.AppSettings["client_log_file"]);
            logFile = new LogFile("client_log_path");
            logFile.SubPath = appKey;
        }

        public DefaultClient(string serviceBase, string code, string key)
        {
            baseUrl = serviceBase;
            appKey = code;
            appSecret = key;
        }
        public T Execute<T>(IRequest<T> request) where T : AbstractResponse
        {
            var webRequest = (HttpWebRequest)WebRequest.Create(baseUrl + request.GetApiName());
            webRequest.Method = "POST";

            string reqJson;
            string sign;
            using (Stream rs = webRequest.GetRequestStream())
            {
                reqJson = JsonConvert.SerializeObject(request);

                byte[] reqBytes = Encoding.UTF8.GetBytes(reqJson);
                rs.Write(reqBytes, 0, reqBytes.Length);
                rs.Close();
            }

            webRequest.ContentType = "application/json";
            webRequest.Headers.Add(SecureHeaderAppKey, appKey);
            sign = ComputeHash(appKey, appSecret, reqJson);
            webRequest.Headers.Add(SecureHeaderSignature, sign);

            //纪录日记
            if (isNeedLogFile)
            {
                logFile.Log(string.Format("[{0}] 请求内容: {1}", request.GetApiCode(), reqJson));
                logFile.Log(string.Format("[{0}] 请求署名: {1}", request.GetApiCode(), sign));
            }

            try
            {
                using (var resp = (HttpWebResponse)webRequest.GetResponse())
                {
                    try
                    {
                        Stream respStream = resp.GetResponseStream();

                        if (respStream == null)
                        {
                            throw new WebException("GetResponseStream returned null");
                        }
                        var streamReader = new StreamReader(respStream);
                        string respStr = streamReader.ReadToEnd();
                        //纪录日记
                        if (isNeedLogFile)
                        {
                            logFile.Log(string.Format("[{0}] 相应内容: {1}", request.GetApiCode(), respStr));
                        }
                        return JsonConvert.DeserializeObject<T>(respStr);
                    }
                    catch (Exception e)
                    {
                        //纪录日记
                        if (isNeedLogFile)
                        {
                            logFile.Log(string.Format("[{0}] 相应毛病: {1}", request.GetApiCode(), e.Message));
                        }
                        throw new ApplicationException(e.Message, e);
                    }
                }
            }
            catch (WebException e)
            {
                var errMsg = new StreamReader(e.Response.GetResponseStream()).ReadToEnd();
                //纪录日记
                if (isNeedLogFile)
                {
                    logFile.Log(string.Format("[{0}] 请求毛病: {1}", request.GetApiCode(), errMsg));
                }
                throw new APIServiceException(errMsg);
            }
        }
        private string ComputeHash(string key, string secret, string body)
        {
            return
                Convert.ToBase64String(
                    SHA1.Create().ComputeHash(Encoding.Default.GetBytes(string.Concat(key, secret, body.Trim()))));
        }
    }

以上就是Api项目端的各个中心环节的细致引见。
接下来会对挪用端即前端举行简朴的引见。Asp.net（三）Web端展现

以上就是Asp.net（二）营业处置惩罚接口项目（Web Api）的细致内容，更多请关注ki4网别的相干文章！