ASP.NET Core 1.0開發Web API程式

.NET Core版本：1.0.0-rc2
Visual Studio版本：Microsoft Visual Studio Community 2015 Update 2
開發及執行平臺：Windows 7 專業版 Service Pack 1 x64

步驟一、建立ASP.NET Core Web API專案

 

 VS裡面新建專案，Web-->ASP.NET Core Web Application(.NET Core)-->Web API，比如本例中建立的TodoApi專案。

步驟二、在Models資料夾中新建實體、介面及服務倉庫

TodoItem.cs（實體類）

namespace TodoApi.Models
{
    public class TodoItem
    {
        public string Key { get; set; }
        public string Name { get; set; }
        public bool IsComplete { get; set; }
    }
}

 

 ITodoRepository.cs（介面類）

using System.Collections.Generic;

namespace TodoApi.Models
{
    public interface ITodoRepository
    {
        void Add(TodoItem item);
        IEnumerable<TodoItem> GetAll();
        TodoItem Find(string key);
        TodoItem Remove(string key);
        void Update(TodoItem item);
    }
}

 TodoRepository.cs（介面實現類，服務的具體實現）

using System;
using System.Collections.Concurrent;
using System.Collections.Generic;

namespace TodoApi.Models
{
    public class TodoRepository : ITodoRepository
    {
        static ConcurrentDictionary<string, TodoItem> _todoItems = new ConcurrentDictionary<string, TodoItem>();

        public TodoRepository()
        {
            Add(new TodoItem() {Name = "Item1"});
        }

        public void Add(TodoItem item)
        {
            item.Key = Guid.NewGuid().ToString();
            _todoItems[item.Key] = item;
        }

        public IEnumerable<TodoItem> GetAll()
        {
            return _todoItems.Values;
        }

        public TodoItem Find(string key)
        {
            TodoItem item;
            _todoItems.TryGetValue(key, out item);
            return item;
        }

        public TodoItem Remove(string key)
        {
            TodoItem item;
            _todoItems.TryGetValue(key, out item);
            _todoItems.TryRemove(key, out item);
            return item;
        }

        public void Update(TodoItem item)
        {
            _todoItems[item.Key] = item;
        }
    }
}

步驟三、在Controllers資料夾中新增Controller類

using System.Collections.Generic;
using Microsoft.AspNetCore.Mvc;
using TodoApi.Models;

namespace TodoApi.Controllers
{
    [Route("api/[controller]")]
    public class TodoController : Controller
    {
        private ITodoRepository TodoItems { get; set; }

        public TodoController(ITodoRepository todoRepository)
        {
            TodoItems = todoRepository;
        }

        [HttpGet]
        public IEnumerable<TodoItem> GetAll()
        {
            return TodoItems.GetAll();
        }

        [HttpGet("{id}", Name = "GetTodo")]
        public IActionResult GetById(string id)
        {
            var item = TodoItems.Find(id);
            if (item == null)
            {
                return NotFound();
            }
            return new ObjectResult(item);
        }

        [HttpPost]
        public IActionResult Create([FromBody] TodoItem todoItem)
        {
            if (null == todoItem)
            {
                return BadRequest();
            }
            TodoItems.Add(todoItem);
            return CreatedAtRoute("GetTodo", new {controller = "todo", id = todoItem.Key}, todoItem);
        }

        public IActionResult Update(string id, [FromBody] TodoItem item)
        {
            if (item == null || item.Key != id)
            {
                return BadRequest();
            }
            var todo = TodoItems.Find(id);
            if (todo == null)
            {
                return NotFound();
            }
            TodoItems.Update(item);
            return new NoContentResult();
        }

        public void Delete(string id)
        {
            TodoItems.Remove(id);
        }
    }
}

 在ASP.NET Core 1.0帶來的新特性這篇文章中有提到ASP.NET Core已經把MVC和Web API整合到一起了，所以我們看到Controller類引用的是Microsoft.AspNetCore.Mvc這個NuGet包了，從字面上也可以看出這個整合。

步驟四、編寫用於啟動應用的主入口程式

progrom.cs

using System.IO;
using Microsoft.AspNetCore.Hosting;

namespace TodoApi
{
    public class Program
    {
        public static void Main(string[] args)
        {
            var host = new WebHostBuilder()
                .UseKestrel()  // 使用Kestrel伺服器
                .UseContentRoot(Directory.GetCurrentDirectory())  // 指定Web伺服器的對應的程式主目錄
                .UseStartup<Startup>()  // 指定Web伺服器啟動時執行的型別，這個約定是Startup類
                .Build(); // 生成Web伺服器
            host.Run(); // 執行Web應用程式
        }
    }
}

步驟五、Startup型別實現

Startup.cs（這個是約定的啟動應用時載入執行的型別，約定包括：型別的名稱，自動生成的相關類方法）

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using TodoApi.Models;

namespace TodoApi
{
    public class Startup
    {
        public Startup(IHostingEnvironment env)
        {
            var builder = new ConfigurationBuilder()
                .SetBasePath(env.ContentRootPath)
                .AddJsonFile("appsettings.json", true, true)
                .AddJsonFile($"appsettings.{env.EnvironmentName}.json", true)
                .AddEnvironmentVariables();
            Configuration = builder.Build();
        }

        public IConfigurationRoot Configuration { get; }

        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            // Add framework services.
            services.AddMvc();

            // Add our respository type
            services.AddSingleton<ITodoRepository, TodoRepository>();
        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
        {
            loggerFactory.AddConsole(Configuration.GetSection("Logging"));
            loggerFactory.AddDebug();

            app.UseMvc();
        }
    }
}

Startup建構函式裡面主要是初始化配置，應用的配置可以是外部自定義的JSON檔案，比如本例中的appsettings.json，我們甚至可以根據不同的環境（FAT,UAT,PRD等）生成給自環境使用的配置檔案，比如：

appsettings.FAT.json、appsettings.UAT.json等，不同的環境根據環境變數{env.EnvironmentName}配置的值來讀取相應的配置檔案。這個{env.EnvironmentName}可以通過專案的Properties下的launchSettings.json檔案進行配置，如下：

{
    "TodoApi": {
      "commandName": "Project",
      "launchBrowser": true,
      "launchUrl": "http://localhost:5000/api/todo",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "PRD"
      }
    }
  }
}

 ConfigureServices,Configure方法的作用在在ASP.NET Core 1.0帶來的新特性這篇文章中已有闡述，這裡不再贅述。

步驟六、執行程式

在cmd裡面把當前目錄切換到專案的根目錄，然後依次執行後面的命令：1、dotnet restore 2、dotnet build 3、dotnet run

執行完dotnet run後，應用程式已經啟動起來了，通過控制檯的輸出提示可以看出，Web伺服器在5000埠偵聽請求。

測試一個URL(http://localhost:5000/api/todo)：

控制檯輸出info日誌：

我們也可以改變控制檯輸出日誌的級別，只需要更改我們自定義的appsettings.json配置即可，如下：

{
  "Logging": {
    "IncludeScopes": false,
    "LogLevel": {
      "Default": "Debug",
      "System": "Debug",
      "Microsoft": "Warning"
    }
  }
}

把“Microsoft”的值改成：“Warning”，這樣上述info級別的日誌就不會再輸出了（Warning,Error級別的日誌才會輸出）。