Asp.net (2) Geschäftsverarbeitungsschnittstellenprojekt (Web-API)

Einführung

ApiAls Anbieter von Geschäftslogik trägt es die Kernlogik des Projekts und weist daher eine relativ hohe Logikkomplexität auf. Unter einer solchen Prämisse geht es darum, wie man das Schreiben von Code vereinfacht, wie man den Schreibstil und die Logikspezifikationen standardisiert und vereinheitlicht und wie man die Wartbarkeit und Skalierbarkeit des Codes verbessert. Es wird wichtig, Projekte mit hoher Kohäsion und geringer Kopplung aufzubauen.
Das Beispiel ist ein Projekt auf Unternehmensebene. Das Framework ist wie unten gezeigt

api layer.jpg

Sicherheit: Die HTTP-Anfrage (Override DelegatingHandler) wird neu geschrieben, die Rechtmäßigkeit wird in den Aspekten der Anfrage beurteilt und die Signaturanforderungen werden vorverarbeitet.
Client: Definiert eine einheitliche Schnittstelle-Aufrufmethode, die vom aufrufenden Ende verwendet wird, wodurch die Verwendung der Schnittstelle vereinfacht und vereinheitlicht wird.
Strg-Ebene: Als direkter Anbieter von Diensten stellt er direkt eine dem RestFul-Stil ähnliche Schnittstelle auf dem Server bereit (es fühlt sich streng im RestFul-Stil an, der ein vollständiges Domänen-ModellTreiber , die tatsächliche Situation ist immer unbefriedigend und die Domänenabstraktionsfähigkeit reicht nicht aus), rufen Sie die Anforderungsdaten ab, rufen Sie nach Bedarf FilterFilter auf, treffen Sie weitere Beurteilungen und rufen Sie
Modell Schicht: Als Geschäftsmodellschicht stellt sie den eigentlichen Betrieb der Geschäftslogik bereit. Verwenden Sie ein einheitliches Entitätsmodell und verbinden Sie es für Datenoperationen mit Ibatis. Die spezifische Codestruktur ist wie folgt:

Api-UML.jpg

Das Folgende ist eine detaillierte Einführung von jedes Modul und Codebeispiel:

Entitätsbibliotheksprojektcodebeispiel

Die Projektstruktur ist wie folgt:

Entität. jpg

Do

main

Modul, als Entitätsmodell lautet der einfache Code wie folgt

Request, das Anforderungsstrukturmodell, verwendet die generische Schnittstelle zum Herstellen einer Verbindung Die Anforderungsklasse und die Rückgabeklasse, die eine Rolle spielen, steuern den Effekt der Inversion.

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

Das Antwortmodul definiert als Rückgabetyp der Anfrage eine einheitliche Rückgabestruktur, um Verbrauchern die Beurteilung und Verarbeitung konsistenter Rückgabecodes zu erleichtern.

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";
        }
    }

Codebeispiel für ein Serviceprojekt

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

Die Projektstruktur ist wie folgt:

service.jpg

Codebeispiel:

Sicherheit

 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();
        }
    }

Klassenbibliothek

CodebeispielDie Klassenbibliothek behandelt nur das Problem

Sicherheit

beim API-Anfrageeintrag Erlaubnisurteil hinzufügen. Verwenden Sie die Methode zum Umschreiben von HTTP-Anfragen. Codebeispiel

Das abstrahierte Berechtigungsurteil kann direkt am Webapi-Ende aufgerufen und dem

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);
        }
    }

Routing

-Konfigurationscode hinzugefügt werden. WebApi-Projektbeispiel

Als eigentliche Definition der Schnittstelle definiert Webapi die tatsächlichen Regeln der Schnittstellendatei und führt die entsprechende

Sicherheitsverwaltung

und Berechtigungskontrolle der Schnittstelle durch . Um die Berechtigungssteuerung von WeChat zu erlernen, wurden mehrere Schnittstellen grob bestimmt:

Schnittstellenberechtigungen.png

Die Beurteilungen dieser Alle Berechtigungen werden platziert. Die zentrale Verwaltung erfolgt in der Sicherheit. Die Schnittstellendefinition muss nur verwendet werden, um die Rechtmäßigkeit der entsprechenden Logik zu beurteilen.

Codebeispiel:

Das Obige ist eine Beispielschnittstelle zum Abrufen von Benutzerinformationen. Als Routing-Konfiguration des Schnittstelleneingangs müssen Sie die Rechtmäßigkeit der Anforderung beurteilen wie folgt:

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;
        }

    }

Codebeispiel für die Client-Klassenbibliothek

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());
}

Die Client-Klassenbibliothek definiert die von der Schnittstelle aufgerufenen öffentlichen Methoden.

1. Verwenden Sie generische Schnittstellen, um die Anforderungsklasse und die Rückgabeklasse zu kapseln, um das Schreiben des aufrufenden Codes zu vereinfachen.

2. Es ermöglicht Verbrauchern auch, Schnittstellen über Proxy-Klassen aufzurufen, wodurch domänenübergreifende Probleme vermieden werden.
3. Alle Verbraucheraufrufe stimmen der Verwendung einer einheitlichen Klassenbibliothek zu, sodass die Protokollverarbeitung einheitlich ist und auch die zurückgegebenen Fehler konsistent definiert werden können.
Das Codebeispiel lautet wie folgt:

 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端展示

Das obige ist der detaillierte Inhalt vonAsp.net (2) Geschäftsverarbeitungsschnittstellenprojekt (Web-API). Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!