在Core環境下用WebRequest連接上遠程的web Api 實現數據的簡單CRUD(附Git地址)

本文所有的東西都是在dot Net Core 1.1環境+VS2017保證測試通過。

本文接着上次文章接着寫的，不了解上篇文章的可能看着有點吃力。我盡量讓大家都能看懂。這是上篇文章的連接http://www.cnblogs.com/qulianqing/p/6745409.html。請大家先看一下，心里大致有個了解，然后看這篇博客就容易了。

這里說一下實現的步驟：1. 新建一個ASP dot Net MVC項目，在這里我的項目名為TestAPI

　　　　　　　　　　　2. 在項目的根目錄下添加一個文件夾 名字為Models

　　　　　　　　　　　3. 在Models文件夾下添加一個Users.cs 類     下面是代碼 和上篇博客的Users.cs一樣  （主要是為了傳輸數據方便）                      

  public class Users
    {
        [Key]
        public int ID { get; set; }
        public string name { get; set; }
        public string pwd { get; set; }
    }

                               4.在右鍵點擊controllers文件夾 選擇添加-->控制器  在彈出的對話框中選擇 mimial Dependencies 之后等待完成。（這里說一下上篇博客有朋友說

                                 選擇 mimial Dependencies會出現錯誤，我今天又試了一遍，還是沒有問題，如果說你的也有問題的話那就選擇full Dependencies）

 

mini）             

　　　　　　　　　      

                                    5.再次右鍵點擊Controllers文件夾 選擇添加 ->控制器 在彈出的對話框中選擇 第三個，也就是下邊高亮的那一個 點擊添加按鈕

                                 6.點擊添加按鈕之后，又會出現一個對話框，在對話框中選擇點擊模型的下拉框，選擇Uses.cs 。在數據上下文項點擊右邊的那個加號，在彈出的對話框中，選將名稱更改為Users，最后記得視圖的三個選項都要勾選。點擊添加 就完成了。

     

                                          7.刪除不必要的東西  （1）刪除Views下邊的整個Home文件夾里邊的東西，（2）刪除整個Data文件夾，及內部東西，（3）刪除Controllers文                                                                        件夾下的HomeController.cs  (4) 打開appsettings.json文件夾 ，刪除ConnectionStrings項及其內容，

　　　　　　　　　　　　　　　　　　　　　　　　　（5）打開Startup.cs文件 刪除EF框架自動添加的服務 在ConfigureServices這個方法里邊，   這個字符串                                　　　　　　　　　　　services.AddDbContext<UsesContext>options=>options.UseSqlServer(Configuration.GetConnectionString("*****")));

                                                                       （6）打開Contollers文件夾下的UserController.cs文件，刪除下邊的系統為我們生成的大部分代碼，刪除完之后就剩下這些

 public class UsersController : Controller
    {
        // GET: Users
        public async Task<IActionResult> Index()
        {
           
        }
        // GET: Users/Details/5
        public async Task<IActionResult> Details(int? id)
        {
            
        }
        // GET: Users/Create
        public IActionResult Create()
        {
      
        }
        // POST: Users/Create
        // To protect from overposting attacks, please enable the specific properties you want to bind to, for 
        // more details see http://go.microsoft.com/fwlink/?LinkId=317598.
        [HttpPost]
        [ValidateAntiForgeryToken]
        public async Task<IActionResult> Create([Bind("ID,name,pwd")] Users users)
        {

        }
        // GET: Users/Edit/5
        public async Task<IActionResult> Edit(int? id)
        {

        }
        // POST: Users/Edit/5
        // To protect from overposting attacks, please enable the specific properties you want to bind to, for 
        // more details see http://go.microsoft.com/fwlink/?LinkId=317598.
        [HttpPost]
        [ValidateAntiForgeryToken]
        public async Task<IActionResult> Edit(int id, [Bind("ID,name,pwd")] Users users)
        {
            
        }
        // GET: Users/Delete/5
        public async Task<IActionResult> Delete(int? id)
        {
            
        }

        // POST: Users/Delete/5
        [HttpPost, ActionName("Delete")]
        [ValidateAntiForgeryToken]
        public async Task<IActionResult> DeleteConfirmed(int id)
        {
           
        }

    }

     進行到這里我們的基礎環境就搭建完畢了，我們這里只用系統為我們生成的View 其他的都不用要，在這里我們的Views文件夾下的Users文件夾的東西我們沒有動

二、接下來重點來了

  我們要在Controllers調用我們上次寫的WebAPI

 首先我們依次從index到Create到Update 到Delete依次為大家詳解（最后附完整的代碼，如果代碼閱讀能力強的同學，可以直接跳到最后閱讀全部的代碼）

准備工作，首先我們聲明兩個全局變量，具體用途在注釋中已經說明

        //這個baseURL是我的webApi的地址
        private static string baseURL = "http://localhost:56853/api/users";
        //用於存放所有的用戶
        private static IList<Users> _context;

構造函數 獲取所有的用戶信息就是把數據存在 _context 中 方便查找

        public UsersController()
        {
            //實例化對象
            _context = new List<Users>();
            //獲取所有的用戶的信息
            _context = GetAllUserList();

        }

在這里我取數據的使用用的是HttpClient取的遠程的API數據，由於取的是JSon字符串數組，我要把它轉化為JSon數組，然后再通過JSonConvert進行每一個對象的轉化

        /// <summary>
        /// 獲取所有用戶的List
        /// </summary>
        private IList<Users> GetAllUserList()
        {
            IList<Users> userslist = new List<Users>();
            var JsonString = GetALLUserInfoFromAPI();
            JArray UsersArray = JArray.Parse(JsonString);
            for (int i = 0; i < UsersArray.Count; i++)
            {
                userslist.Add(StringConvertToUser(UsersArray[i].ToString()));
            }
            return userslist;
        }

        /// <summary>
        /// 通過api獲取所有的用戶的信息
        /// </summary>
        /// <returns>JSON String</returns>
        private string GetALLUserInfoFromAPI()
        {
            HttpClient client = new HttpClient();
            var con = client.GetStringAsync(baseURL);
            return con.Result;
        }

        /// <summary>
        /// 將Json對象的字符串轉化為users對象
        /// </summary>
        /// <param name="JsonString">json對象的字符串</param>
        /// <returns>Users對象</returns>
        private Users StringConvertToUser(string JsonString)
        {
            return JsonConvert.DeserializeObject<Users>(JsonString);
        }

 1.index 界面是用來顯示數據的。通過上邊的操作，我們已經把所有的數據存到 _context 變量中去了，所以在Index中我們只需要調用就可以了。

        public async Task<IActionResult> Index()
        {
            return View(_context);
        }

運行結果:

2.接下來我們接着說Create和Rdit和Delete 由於Create和Edit都是向服務器提交數據的，Delete向遠程API路由一個ID就結束了。這里我原本准備全文都用HttpClient的可是HttpClient的PostAsync方法實在是不會用，昨天搞了一天都沒有結果，於是下邊的我換成了WebRequest，我把他們提取到一個方法里了，具體看下邊的代碼。尤其是我下邊注釋的行代碼，不然瀏覽器會報415讓你摸不着頭腦，這個是我自己試出來的，可能會有更好的方法吧。只是我還不知道。

        /// <summary>
        /// 處理數據
        /// </summary>
        /// <param name="Data">User實體類</param>
        /// <param name="Url">遠程API的URL</param>
        /// <param name="RequestMethod">請求的方法</param>
        /// <returns></returns>
        private async Task<string> HandleData(Users Data, string Url, string RequestMethod)
        {
            string UsersJson = UsersConvertToJson(Data);
            var request = WebRequest.CreateHttp(Url);
            request.Accept = "application/json";
            //下邊這行不設置會出現無法識別mediaType 415 這個錯誤
            request.ContentType = "application/json";
            request.Method = RequestMethod;
            //向request提交數據
            using (StreamWriter writer = new StreamWriter(await request.GetRequestStreamAsync()))
            {
                writer.Write(UsersJson);
            }
            //獲取響應
            var reponse = await request.GetResponseAsync();
            //返回響應數據
            using (StreamReader reader = new StreamReader(reponse.GetResponseStream()))
            {
                return reader.ReadToEnd();
            }
        }

        private string UsersConvertToJson(Users u)
        {
            return JsonConvert.SerializeObject(u);
        }

具體用法 Create

        /// <summary>
        /// 傳遞數據到遠程API的數據庫中
        /// </summary>
        /// <param name="u"></param>
        /// <returns></returns>
        private async Task<string> CreateAsync(Users u)
        {
            string url = baseURL;
            string requestMethod = "post";
            return await HandleData(u, url, requestMethod);         
        }



      // GET: Users/Create
        public IActionResult Create()
        {
            return View();
        }

        // POST: Users/Create
        // To protect from overposting attacks, please enable the specific properties you want to bind to, for 
        // more details see http://go.microsoft.com/fwlink/?LinkId=317598.
        [HttpPost]
        [ValidateAntiForgeryToken]
        public async Task<IActionResult> Create([Bind("ID,name,pwd")] Users users)
        {
            if (ModelState.IsValid)
            {
               
                await CreateAsync(users);
                return RedirectToAction("Index");
            }
            return View();
        }

具體用法 Edit

        private async Task<string> UpdateAsync(Users u)
        {
            string url = baseURL + @"/" + u.ID;
            string requestMethod = "put";
            return await HandleData(u, url, requestMethod);
        }



      // GET: Users/Edit/5
        public async Task<IActionResult> Edit(int? id)
        {
            if (id == null)
            {
                return BadRequest();
            }
            var users = _context.FirstOrDefault(u => u.ID == id);
            if (users == null)
            {
                return NotFound();
            }
            return View(users);
        }

        // POST: Users/Edit/5
        // To protect from overposting attacks, please enable the specific properties you want to bind to, for 
        // more details see http://go.microsoft.com/fwlink/?LinkId=317598.
        [HttpPost]
        [ValidateAntiForgeryToken]
        public async Task<IActionResult> Edit(int id, [Bind("ID,name,pwd")] Users users)
        {

            if (ModelState.IsValid)
            {
                if (id != users.ID)
                {
                    return BadRequest();
                }
                try
                {
                    await UpdateAsync(users);
                    return RedirectToAction("Index");
                }
                catch
                {
                    if (UsersExist(users.ID))
                    {
                        return NotFound();
                    }
                    throw;
                }

            }
            return View();
        }

       private bool UsersExist(int iD)
        {
            return _context.Any(u => u.ID == iD);
        }

具體用法 Delete

        private async Task<string> DeleteAsync(Users u)
        {
            string url = baseURL + @"/" + u.ID;
            string requestMethod = "delete";
            return await HandleData(u, url, requestMethod);
        }



       // GET: Users/Delete/5
        public async Task<IActionResult> Delete(int? id)
        {
            if (id == null)
            {
                return BadRequest();
            }
            var users = _context.FirstOrDefault(u => u.ID == id);
            if (users == null)
            {
                return NotFound();
            }

            return View(users);
        }

        // POST: Users/Delete/5
        [HttpPost, ActionName("Delete")]
        [ValidateAntiForgeryToken]
        public async Task<IActionResult> DeleteConfirmed(int id)
        {
            var users = _context.SingleOrDefault(u => u.ID == id);
            await DeleteAsync(users);
            return RedirectToAction("Index");
        }

到這里調用遠程API的東西都完成了，我在這里完善了一下 Details這個View

       // GET: Users/Details/5
        public async Task<IActionResult> Details(int? id)
        {
            if (id == null)
            {
                return BadRequest();
            }
            var users = _context.FirstOrDefault(u => u.ID == id);
            if (users == null)
            {
                return NotFound();
            }
            return View(users);
        }

下邊這是測試結果

 

 

到這里全部都完成了，並且測試完畢

這是UsersContellers.cs 類的全部代碼

using Microsoft.AspNetCore.Mvc;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using TestAPI.Models;

namespace TestAPI.Controllers
{
    public class UsersController : Controller
    {
        #region 成員變量
        //這個baseURL是我的webApi的地址
        private static string baseURL = "http://localhost:56853/api/users";
        //用於存放所有的用戶
        private static IList<Users> _context;
 
        #endregion

        #region 構造函數
        public UsersController()
        {
            //實例化對象
            _context = new List<Users>();
            //獲取所有的用戶的信息
            _context = GetAllUserList();

        }

        #endregion

        #region 類內方法

       
        ///  https://docs.microsoft.com/en-us/aspnet/web-api/overview/advanced/calling-a-web-api-from-a-net-client
      


        /// <summary>
        /// 通過api獲取所有的用戶的信息
        /// </summary>
        /// <returns>JSON String</returns>
        private string GetALLUserInfoFromAPI()
        {
            HttpClient client = new HttpClient();
            var con = client.GetStringAsync(baseURL);
            return con.Result;
        }

        private string UsersConvertToJson(Users u)
        {
            return JsonConvert.SerializeObject(u);
        }
        /// <summary>
        /// 傳遞數據到遠程API的數據庫中
        /// </summary>
        /// <param name="u"></param>
        /// <returns></returns>
        private async Task<string> CreateAsync(Users u)
        {
            string url = baseURL;
            string requestMethod = "post";
            return await HandleData(u, url, requestMethod);         
        }

        private async Task<string> UpdateAsync(Users u)
        {
            string url = baseURL + @"/" + u.ID;
            string requestMethod = "put";
            return await HandleData(u, url, requestMethod);
        }
        /// <summary>
        /// 處理數據
        /// </summary>
        /// <param name="Data">User實體類</param>
        /// <param name="Url">遠程API的URL</param>
        /// <param name="RequestMethod">請求的方法</param>
        /// <returns></returns>
        private async Task<string> HandleData(Users Data, string Url, string RequestMethod)
        {
            string UsersJson = UsersConvertToJson(Data);
            var request = WebRequest.CreateHttp(Url);
            request.Accept = "application/json";
            //下邊這行不設置會出現無法識別mediaType 415 這個錯誤
            request.ContentType = "application/json";
            request.Method = RequestMethod;
            //向request提交數據
            using (StreamWriter writer = new StreamWriter(await request.GetRequestStreamAsync()))
            {
                writer.Write(UsersJson);
            }
            //獲取響應
            var reponse = await request.GetResponseAsync();
            //返回響應數據
            using (StreamReader reader = new StreamReader(reponse.GetResponseStream()))
            {
                return reader.ReadToEnd();
            }
        }
        private async Task<string> DeleteAsync(Users u)
        {
            string url = baseURL + @"/" + u.ID;
            string requestMethod = "delete";
            return await HandleData(u, url, requestMethod);
        }
        private bool UsersExist(int iD)
        {
            return _context.Any(u => u.ID == iD);
        }

        /// <summary>
        /// 獲取所有用戶的List
        /// </summary>
        private IList<Users> GetAllUserList()
        {
            IList<Users> userslist = new List<Users>();
            var JsonString = GetALLUserInfoFromAPI();
            JArray UsersArray = JArray.Parse(JsonString);
            for (int i = 0; i < UsersArray.Count; i++)
            {
                userslist.Add(StringConvertToUser(UsersArray[i].ToString()));
            }
            return userslist;
        }
        /// <summary>
        /// 將Json對象的字符串轉化為users對象
        /// </summary>
        /// <param name="JsonString">json對象的字符串</param>
        /// <returns>Users對象</returns>
        private Users StringConvertToUser(string JsonString)
        {
            return JsonConvert.DeserializeObject<Users>(JsonString);
        }
        #endregion

        #region Index
        // GET: Users
        public async Task<IActionResult> Index()
        {
            return View(_context);
        }



        #endregion

        #region Details

        // GET: Users/Details/5
        public async Task<IActionResult> Details(int? id)
        {
            if (id == null)
            {
                return BadRequest();
            }
            var users = _context.FirstOrDefault(u => u.ID == id);
            if (users == null)
            {
                return NotFound();
            }
            return View(users);
        }

        #endregion

        #region Create

        // GET: Users/Create
        public IActionResult Create()
        {
            return View();
        }

        // POST: Users/Create
        // To protect from overposting attacks, please enable the specific properties you want to bind to, for 
        // more details see http://go.microsoft.com/fwlink/?LinkId=317598.
        [HttpPost]
        [ValidateAntiForgeryToken]
        public async Task<IActionResult> Create([Bind("ID,name,pwd")] Users users)
        {
            if (ModelState.IsValid)
            {
               
                await CreateAsync(users);
                return RedirectToAction("Index");
            }
            return View();
        }

        #endregion

        #region Edit

        // GET: Users/Edit/5
        public async Task<IActionResult> Edit(int? id)
        {
            if (id == null)
            {
                return BadRequest();
            }
            var users = _context.FirstOrDefault(u => u.ID == id);
            if (users == null)
            {
                return NotFound();
            }
            return View(users);
        }

        // POST: Users/Edit/5
        // To protect from overposting attacks, please enable the specific properties you want to bind to, for 
        // more details see http://go.microsoft.com/fwlink/?LinkId=317598.
        [HttpPost]
        [ValidateAntiForgeryToken]
        public async Task<IActionResult> Edit(int id, [Bind("ID,name,pwd")] Users users)
        {

            if (ModelState.IsValid)
            {
                if (id != users.ID)
                {
                    return BadRequest();
                }
                try
                {
                    await UpdateAsync(users);
                    return RedirectToAction("Index");
                }
                catch
                {
                    if (UsersExist(users.ID))
                    {
                        return NotFound();
                    }
                    throw;
                }

            }
            return View();
        }


        #endregion

        #region Delete


        // GET: Users/Delete/5
        public async Task<IActionResult> Delete(int? id)
        {
            if (id == null)
            {
                return BadRequest();
            }
            var users = _context.FirstOrDefault(u => u.ID == id);
            if (users == null)
            {
                return NotFound();
            }

            return View(users);
        }

        // POST: Users/Delete/5
        [HttpPost, ActionName("Delete")]
        [ValidateAntiForgeryToken]
        public async Task<IActionResult> DeleteConfirmed(int id)
        {
            var users = _context.SingleOrDefault(u => u.ID == id);
            await DeleteAsync(users);
            return RedirectToAction("Index");
        }
        #endregion

    }
}

這是git地址  https://github.com/1483523635/dotNetCoreAPIDemoTest

關於HttpClient的學習微軟官網上有一篇 https://docs.microsoft.com/en-us/aspnet/web-api/overview/advanced/calling-a-web-api-from-a-net-client 這個我看了一下時間是2014年的，昨天還能看今天就看不到了，可能是要更新吧 

這是HttpClient的API說明  https://msdn.microsoft.com/en-us/library/system.net.http.httpclient(v=vs.118).aspx

關於HttpClient的PostAsync方法誰有好的用法，歡迎告訴我，讓我學習一下。