• WebAPI项目搭建及其发布测试

    目录

    1.创建项目

    2.配置

    3.发布

    4.测试页面

    1.创建项目

    （1）创建ASP.NET Web应用程式，如下图：

    （2）选择Empty,勾选Web API，点击确定创建，如下图：

    （3）创建完成，如下图：

    （4）添加文件夹及类，如下图：      

      

     说明：BLL（存放数据库相关的类），TestController（接口类），Models（存放Models类），MPage（存放啟動頁面，沒有任何功能）

    2.配置

    （1）Web.config配置文件，配置数据库连接及跨域，代码如下：

    2.   
    3.   
    4.     
    5.       
    6.     <add key="DBConnectionString1" value="Data Source=1.3.1.1;Initial Catalog=total;Persist Security Info=True;User ID=SC;Password=SCQSMPTD;MultipleActiveResultSets=true" />
    7.     
    8.     <add key="DBConnectionString2" value="Data Source=1.3.1.3;Initial Catalog=SMT_PCP;Persist Security Info=True;User ID=micro;Password=micro;MultipleActiveResultSets=true" />
    9.     
    10.     <add key="OraConn"
    11.          value="Data Source=(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=1.3.1.22)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=PACK)));User Id=e_re;Password=yhong;"/>   
    12.   
    13.  
    14.     
    15.       
    16.       
    17.         <add name="Access-Control-Allow-Origin" value="*" />
    18.         
    19.         <add name="Access-Control-Allow-Methods" value="GET, POST, PUT, DELETE, OPTIONS" />
    20.         
    21.         <add name="Access-Control-Allow-Headers" value="Content-Type,X-Requested-With,token,staffid,timestamp,nonce,signKey,signature" />
    22.         
    23.         <add name="Access-Control-Request-Methods" value="GET, POST, PUT, DELETE, OPTIONS" />
    24.         
    25.       
    26.       
    27.     
    28.   
    29.

     （2）在Global.asax文件中添加，下面代码：

    1.   protected void Application_BeginRequest(object sender, EventArgs e)
    2.         {
    3.             var res = HttpContext.Current.Response;
    4.             var req = HttpContext.Current.Request;
    5.  
    6.             //自定义header时进行处理
    7.             if (req.HttpMethod == "OPTIONS")
    8.             {
    9.                 res.AppendHeader("Access-Control-Allow-Headers", "Content-Type, X-CSRF-Token, X-Requested-With, Accept, Accept-Version, Content-Length, Content-MD5, Date, X-Api-Version, X-File-Name,Token,Cookie");
    10.                 res.AppendHeader("Access-Control-Allow-Methods", "POST,GET,PUT,PATCH,DELETE,OPTIONS");
    11.                 res.StatusCode = 200;
    12.                 res.End();
    13.             }
    14.         }

    （3）啟動頁面：Hello.aspx

    1. <%@ Page Language="C#" AutoEventWireup="true" CodeBehind="Hello.aspx.cs" Inherits="WebAPI.MPage.Hello" %>
    2.  
    4.  
    5. "http://www.w3.org/1999/xhtml">
    6. "server">
    7. "Content-Type" content="text/html; charset=utf-8"/>
    8.     
    11.     
      "form1" runat="server">
    12.     
    13.       這個界面只是一個啟動頁面，沒有任何功能
    14.

    • （4）webapi设置默认返回json格式 ，WebApiConfig文件下Register方法下，添加代码：

    1.    GlobalConfiguration.Configuration.Formatters.XmlFormatter.SupportedMediaTypes.Clear();
    2.             //默认返回 json  
    3.             GlobalConfiguration.Configuration.Formatters.JsonFormatter.MediaTypeMappings.Add(
    4.                 new QueryStringMapping("datatype", "json", "application/json"));
    5.  
    6.             // 解决json序列化时的循环引用问题
    7.             config.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;

    （5）BLL文件夹下创建一个SQLHelper类，用于连接数据库，代码：

    1. using Oracle.ManagedDataAccess.Client;
    2. using System;
    3. using System.Collections.Generic;
    4. using System.Configuration;
    5. using System.Data;
    6. using System.Data.SqlClient;
    7. using System.Linq;
    8. using System.Text;
    9. using System.Web;
    10.  
    11. namespace WebAPI.BLL
    12. {
    13.     /// 
    14.     /// 鏈接類別
    15.     /// 
    16.     public enum DBConnList
    17.     {
    18.         DBConnStr1 = 0,
    19.         DBConnStr2 = 1,
    20.         QracleConnS = 2,
    21.     }
    22.     public static class SQLHelper
    23.     {
    24.         //数据库1
    25.         public static string DBConnectionString1 = ConfigurationManager.AppSettings["DBConnectionString1"];
    26.         //数据库2
    27.         public static string DBConnectionString2 = ConfigurationManager.AppSettings["DBConnectionString2"];
    28.         //Qracle数据库操作
    29.         public static string QracleSring = ConfigurationManager.AppSettings["OraConn"];
    30.       
    31.         /// 
    32.         /// 獲得數據庫鏈接語句
    33.         /// 
    34.         /// 請求數據庫類別
    35.         /// 
    36.         public static string GetConnectStr(DBConnList DBConnIndex)
    37.         {
    38.             var connstr = "";
    39.  
    40.             if (DBConnIndex == DBConnList.DBConnStr1)
    41.             {
    42.                 connstr = DBConnectionString1;
    43.             }
    44.             else if (DBConnIndex == DBConnList.DBConnStr2)
    45.             {
    46.                 connstr = DBConnectionString2;
    47.             }
    48.             else if (DBConnIndex == DBConnList.QracleConnS)
    49.             {
    50.                 connstr = QracleSring;
    51.             }
    52.  
    53.             return connstr;
    54.         }
    55.         //SQL 数据库操作
    56.         #region
    57.         /// 
    58.         /// 增刪改查，不涉及事物
    59.         /// 
    60.         /// 
    61.         /// 請求數據庫類別
    62.         /// 
    63.         public static int ExecuteSQL(string sql, DBConnList DBConnIndex)
    64.         {
    65.             var connstr = GetConnectStr(DBConnIndex);
    66.  
    67.             SqlConnection conn = new SqlConnection(connstr);
    68.  
    69.             SqlCommand cmd = new SqlCommand(sql, conn);
    70.  
    71.             conn.Open();
    72.  
    73.             int result = cmd.ExecuteNonQuery();
    74.  
    75.             conn.Close();
    76.  
    77.             return result;
    78.         }
    79.  
    80.         /// 
    81.         /// 执行带SqlParameter的SQL语句
    82.         /// 
    83.         /// 
    84.         /// 請求數據庫類別
    85.         /// 參數
    86.         /// 
    87.         public static int ExecuteSQLAndSP(string sql, DBConnList DBConnIndex, List sp)
    88.         {
    89.             var connstr = GetConnectStr(DBConnIndex);
    90.  
    91.             SqlConnection connection = new SqlConnection(connstr);
    92.  
    93.             try
    94.             {
    95.                 connection.Open();
    96.  
    97.                 SqlCommand cmd = new SqlCommand(sql, connection);
    98.  
    99.                 foreach (SqlParameter cur_sp in sp)
    100.                 {
    101.                     if (cur_sp.Value != null)
    102.                     {
    103.                         cmd.Parameters.Add(cur_sp);
    104.                     }
    105.                 }
    106.  
    107.                 return cmd.ExecuteNonQuery();
    108.             }
    109.             finally
    110.             {
    111.                 connection.Close();
    112.             }
    113.         }
    114.  
    115.         /// 
    116.         /// 執行多條SQL語句，實現數據庫事物
    117.         /// 
    118.         /// 多條SQL語句
    119.         /// 請求數據庫類別 
    120.         /// 1 表示執行成功；2 表示出現錯誤了。
    121.         public static void ExecuteSQLTran(List<string> SQLStringList, DBConnList DBConnIndex, ref int result)
    122.         {
    123.             var connstr = GetConnectStr(DBConnIndex);
    124.  
    125.             using (SqlConnection conn = new SqlConnection(connstr))
    126.             {
    127.                 conn.Open();
    128.                 SqlCommand cmd = new SqlCommand();
    129.                 cmd.Connection = conn;
    130.                 SqlTransaction tx = conn.BeginTransaction();
    131.                 cmd.Transaction = tx;
    132.  
    133.                 int curIndex = 0;
    134.  
    135.                 try
    136.                 {
    137.                     for (int n = 0; n < SQLStringList.Count; n++)
    138.                     {
    139.                         string strsql = SQLStringList[n].ToString();
    140.                         if (strsql.Trim().Length > 1)
    141.                         {
    142.                             cmd.CommandText = strsql;
    143.                             cmd.ExecuteNonQuery();
    144.  
    145.                             curIndex = curIndex + 1;
    146.                         }
    147.                     }
    148.                     tx.Commit();
    149.  
    150.                     result = 1;
    151.                 }
    152.                 catch (SqlException ex)
    153.                 {
    154.                     result = 2;
    155.  
    156.                     Add_Log("ExecuteSqlTran:" + SQLStringList[curIndex] + " \r\n Error:" + ex.Message);
    157.  
    158.                     tx.Rollback();
    159.                     //throw new Exception(E.Message);
    160.                 }
    161.             }
    162.         }
    163.  
    164.         /// 
    165.         /// 查詢
    166.         /// 
    167.         /// 需要執行的SQL語句
    168.         /// 請求數據庫類別
    169.         /// 
    170.         public static DataTable SearchSQL(string sql, DBConnList DBConnIndex)
    171.         {
    172.             var connstr = GetConnectStr(DBConnIndex);
    173.  
    174.             DataSet ds = new DataSet();
    175.  
    176.             SqlDataAdapter sda = new SqlDataAdapter(sql, connstr);
    177.  
    178.             sda.Fill(ds);
    179.  
    180.             return ds.Tables[0];
    181.         }
    182.         public static DataTable Only_Table1(string exec, DBConnList DBConnIndex)
    183.         {
    184.             var connstr = GetConnectStr(DBConnIndex);
    185.             System.Data.DataTable dt_jdl = new DataTable();
    186.             try
    187.             {
    188.                 using (SqlConnection con = new SqlConnection(connstr))
    189.                 {
    190.                     if (con.State == ConnectionState.Closed)
    191.                     {
    192.                         con.Open();
    193.                     } if (con.State == ConnectionState.Open || con.State == ConnectionState.Connecting)
    194.                     {
    195.                         SqlDataAdapter sda2 = new SqlDataAdapter(exec, con);//全部通過寫存儲過程即可
    196.                         DataSet ds2 = new DataSet();
    197.                         sda2.Fill(ds2, "cxq");
    198.                         dt_jdl = ds2.Tables["cxq"];
    199.                         sda2.Dispose();
    200.                         ds2.Dispose();
    201.                     }
    202.                     con.Close();
    203.                 }
    204.                 return dt_jdl;
    205.             }
    206.             catch (Exception EX)
    207.             {
    208.                 return null;
    209.             }
    210.         }
    211.  
    212.         /// 
    213.         /// 增加日志
    214.         /// 
    215.         /// 
    216.         public static void Add_Log(string msg)
    217.         {
    218.             //msg = msg.Replace("'", "");
    219.  
    220.             //StringBuilder sb = new StringBuilder();
    221.  
    222.             //sb.AppendLine("Insert into SimpHomeDB.dbo.SYS_LOG (msg)");
    223.  
    224.             //sb.AppendLine("Values(N'[SimploScreenAPI]" + msg + "')");
    225.  
    226.             //ExecuteSQL(sb.ToString(), DBConnList.DBConnStrTE);
    227.         }
    228.         #endregion
    229.         //Qracle数据库操作
    230.         #region
    231.         
    232.         /// 
    233.         ///  执行SQL语句,返回DataTable;只用来执行查询结果比较少的情况
    234.         /// 
    235.         /// 
    236.         /// 
    237.         /// 
    238.         /// 
    239.         public static DataTable QracleExecuteDataTableSQL(string sql, DBConnList DBConnIndex,params OracleParameter[] parameters)
    240.         {
    241.             var connStr = GetConnectStr(DBConnIndex);
    242.             using (OracleConnection conn = new OracleConnection(connStr))
    243.             {
    244.                 conn.Open();
    245.                 using (OracleCommand cmd = conn.CreateCommand())
    246.                 {
    247.                     cmd.CommandText = sql;
    248.                     cmd.Parameters.AddRange(parameters);
    249.                     OracleDataAdapter adapter = new OracleDataAdapter(cmd);
    250.                     DataTable datatable = new DataTable();
    251.                     adapter.Fill(datatable);
    252.                     return datatable;
    253.                 }
    254.             }
    255.         }
    256.         /// 
    257.         /// 执行SQl语句（增、删、改）
    258.         /// 
    259.         /// 要执行的SQl语句
    260.         /// 
    261.         public static bool Qracle_EXCUTE(string sql, DBConnList DBConnIndex)
    262.         {
    263.             var connStr = GetConnectStr(DBConnIndex);
    264.             try
    265.             {
    266.                 OracleConnection connect = new OracleConnection(connStr);
    267.                 OracleCommand cmd = new OracleCommand();
    268.                 cmd.Connection = connect;
    269.                 cmd.CommandText = sql;
    270.                 connect.Open();
    271.                 cmd.ExecuteNonQuery();
    272.                 connect.Close();
    273.                 return true;
    274.             }
    275.             catch (Exception ex)
    276.             {
    277.                 throw new Exception(ex.Message);
    278.             }
    279.         }
    280.         #endregion
    281.     }
    282. }

    （6）Models文件下的类，例SysResponse类：

    1.  /// 
    2.     /// 返回信息
    3.     /// 
    4.     public class SysResponse
    5.     {
    6.         /// 
    7.         /// 状态码
    8.         /// 
    9.         public string Code { get; set; }
    10.  
    11.         /// 
    12.         /// 描述信息
    13.         /// 
    14.         public string Message { get; set; }
    15.  
    16.         /// 
    17.         /// 数据
    18.         /// 
    19.         public object Data { get; set; }
    20.            
    21.        
    22.     }

    Common类

    1.  public class Common
    2.     {
    3.          /// 
    4.         /// 轉化成Json
    5.         /// 
    6.         /// 待轉換對象
    7.         /// 轉換結果/returns>
    8.         public static HttpResponseMessage ToJson(Object obj)
    9.         {
    10.             String str;
    11.             if (obj is String || obj is Char)
    12.             {
    13.                 str = obj.ToString();
    14.             }
    15.             else
    16.             {
    17.                 JavaScriptSerializer serializer = new JavaScriptSerializer();
    18.                 str = serializer.Serialize(obj);
    19.             }
    20.             HttpResponseMessage result = new HttpResponseMessage { Content = new StringContent(str, Encoding.GetEncoding("UTF-8"), "application/json") };
    21.  
    22.             return result;
    23.         }      
    24.     }

    （7）接口类TestController 

    1.  public class TestController : ApiController
    2.     {     
    3.         [HttpGet]
    4.         public HttpResponseMessage HelloOne(string Line)
    5.         {
    6.             SysResponse res = new SysResponse();
    7.             try
    8.             {
    9.                 //sql数据库
    10.                 var emp_dt = SQLHelper.SearchSQL("select * from pcp where Line = '" + Line + "'", DBConnList.DBConnStr1);
    11.                 //Qracle数据库
    12.                 //var emp_dt = SQLHelper.QracleExecuteDataTableSQL("select * from (select * from scqhp.cell_sort_info_by_customer) where ROWNUM<=10 ORDER BY ROWNUM asc", DBConnList.QracleConnS);
    13.  
    14.                 //var GoodsNo = emp_dt.Rows[0]["CELL_SN"].ToString();
    15.                 var GoodsNo = emp_dt.Rows[0]["P_N"].ToString();
    16.                 res.Code = "01";
    17.                 res.Message = GoodsNo;
    18.                 res.Data = "001";
    19.             }
    20.             catch (Exception ex)
    21.             {
    22.                 res.Code = "02";
    23.                 res.Message = "調用失敗Hello，Exception:" + ex.Message + Line;
    24.                 res.Data = "002";
    25.             }
    26.  
    27.             return Common.ToJson(res);
    28.         }
    29.  
    30.         
    31.     }

    说明：其中  [HttpGet]可以按照需求更改为  [HttpPost]  [HttpPut]  [HttpDelete]

    3.发布

    写好的接口需要发布到服务器或者本机的IIS进行测试，发布与发布网页一样

    4.测试页面

    1. html>
    2. <html>
    3. <head>
    4.     <meta charset="utf-8">
    5.     <meta name="viewport" content="width=device-width, initial-scale=1">
    6.     <script src="jquery-1.10.2.min.js">script>
    7.     <style>
    8.  
    9.     style>
    10.     <title>webapi测试title>
    11. head>
    12. <body>
    13.     <div id="body">      
    14.         <section>
    15.  
    16.             <br />
    17.             <br />
    18.             <h2>查询物料h2>
    19.             Line：<input id="line" type="text" value="PZ01"/><br /> 
    20.             料号：<input id="GoodsNo" type="text" /><br />           
    21.             <input id="showItem" type="button" value="查询" />                       
    22.         section>
    23.  
    24.     div>
    25.  
    26.     <script>   
    27.         //先根据Id查询记录  请求类型:GET  请求url:  /api/Products/Id
    28.         //请求到ProductsController.cs中的 public Product GetProduct(int id) 方法
    29.         $("#showItem").click(function () {
    30.             var inputLine = $("#line").val();
    31.             $.ajax({
    32.                 url: "http://10.20.32.73:8000//api/Test/HelloOne?Line=" + inputLine,
    33.                 type: "get",
    34.                 dataType: 'json',            
    35.                 success: function (data) {
    36.                     $("#GoodsNo").val(data.Message);
    37.                 },
    38.                 error: function (XMLHttpRequest, textStatus, errorThrown) {
    39.                     alert("请求失败，消息：" + textStatus + "  " + errorThrown);
    40.                 }
    41.             });
    42.         });
    43.     script>
    44.  
    45. body>
    46. html>

    说明：其中http://10.20.32.73:8000为发布webAPI的网址

    总结：本文主要讲述了WebAPI项目的搭建及其配置，然后到发布及其测试整个过程。记录方便查阅。

  • 相关阅读:
    云容灾最佳实践！美创DBRA助力包头医学院第二附属医院核心系统容灾建设
    DHCP（自动分配ip地址实验案例）
    css取消移动端长按元素背景色
    Android FileObserver 的使用与简要原理
    据说，这是90%项目经理都会犯的错
    Java之序列化的详细解析
    双飞翼布局
    图书管理系统
    React 简书项目实战【3】实现搜索框动画
    2023国赛 C题论文 蔬菜类商品自动定价与补货策略
  • 原文地址：https://blog.csdn.net/qq_42711010/article/details/128146328