如何在Mvc 6 中创建 Web Api以及如何脱离IIS实现自我托管

时间:2021-10-08 19:52:54

微软推出的Asp.net vNext(asp.net 5.0)的其中的一个目标就是统一mvc 和web api 的框架。接下来我就演示一下一下几个内容

1,怎么在Asp.net mvc 6 中创建简单的web api。

2,怎么在空的项目工程中添加程序需要的组件。

3,怎么去配置Asp.net 5.0 管道。

4,怎么不通过IIS自我托管。

首先需要安装Visual Studio 2015 Preview,安装完之后,打开File >New >Project 然后 Template>C#>Web 新建一个Asp.Net Web Application 我命名为WebApiDemo:之后要选择 Asp.net 5 Empty 然后选择ok 就可以了 :

如何在Mvc 6 中创建 Web Api以及如何脱离IIS实现自我托管

项目包括如下几个文件:

如何在Mvc 6 中创建 Web Api以及如何脱离IIS实现自我托管

  • global.json 是包括整个solution的设置并且可以确保项目和项目之间的引用。
  • project.json 是这个工程的配置。
  • Startup.cs 是 startup 和 配置的代码。

在Startup.cs 中配置asp.net 的请求管道,

 public class Startup
{
public void Configure(IApplicationBuilder app)
{
// Nothing here!
}
}

如果现在运行项目会发现什么也没有,那我们就先简单的添加一个欢迎页面,打开project.json 文件,这个文件可以配置我们这个程序的一些设置

 {
"webroot": "wwwroot",
"version": "1.0.0-*",
"exclude": [
"wwwroot"
],
"packExclude": [
"**.kproj",
"**.user",
"**.vspscc"
],
"dependencies": {
"Microsoft.AspNet.Server.IIS": "1.0.0-beta1"
},
"frameworks" : {
"aspnet50" : { },
"aspnetcore50" : { }
}
}

其中 "dependencies" 是一些Nuget 包和类库。我们先添加一个 Microsoft.AspNet.Diagnostics 。添加的时候会有只能提示。

如何在Mvc 6 中创建 Web Api以及如何脱离IIS实现自我托管

"dependencies": {
"Microsoft.AspNet.Server.IIS": "1.0.0-beta1",
"Microsoft.AspNet.Diagnostics": "1.0.0-beta1"
},

然后再Startup.cs 中添加

  public class Startup
{
public void Configure(IApplicationBuilder app)
{
// For more information on how to configure your application, visit http://go.microsoft.com/fwlink/?LinkID=398940 app.UseWelcomePage();
}
}

然后f5 运行 效果就出来了:

如何在Mvc 6 中创建 Web Api以及如何脱离IIS实现自我托管

简单的创建了一个页面,接下来我们就进入正题,创建web api。

同样我们需要在project.json 中添加mvc 6的包

   "dependencies": {
"Microsoft.AspNet.Server.IIS": "1.0.0-beta1",
"Microsoft.AspNet.Diagnostics": "1.0.0-beta1",
"Microsoft.AspNet.Mvc": "6.0.0-beta1"
},

接下来添加mvc 的请求管道在startup.cs 中

先引用 Microsoft.Framework.DependencyInjection,

然后添加如下方法:

  public void ConfigureServices(IServiceCollection services)
{ services.AddMvc();
}

注意方法名不要错了,在程序启动的时候 mvc 框架会自动运行这个方法。

然后在 Startup.cs 的configure方法中添加代码: app.UseMvc();

然后新建一个Models文件夹 里面新建一个类Test

     public class Test
{
public int Id { get; set; }
[Required]
public string Title { get; set; }
}

同样新建一个文件夹Controller 然后新建一个HomeController 的Wep Api 的 controller。

 namespace WebApiDemo.Controllers.Controllers
{
//注意这个写法,web api 的路由 不要忘了前面的api当然你可以随意的命名
[Route("api/[controller]")]
public class HomeController : Controller
{ public static List<Test> list = new List<Test>() {
new Test() { Id=, Title="test1" },
new Test() { Id=, Title="test2" }
}; // GET: api/values
//获得所有数据
[HttpGet]
public IEnumerable<Test> Get()
{
return list;
} //按照id 查找数据 其中HttpGet 中 {id} 是模板 Name是路由的名字在mvc 5中的api 中HttpGet 是没有参数的。
// GET api/values/5
[HttpGet("{id}", Name = "getbyid")]
public IActionResult Get(int id)
{
var item = list.FirstOrDefault(p => p.Id.Equals(id)); if (item == null)
{
return HttpNotFound();
} return new ObjectResult(item); } // POST api/values
//添加数据
[HttpPost]
public void Post([FromBody]Test value)
{
if (!ModelState.IsValid)
{
Context.Response.StatusCode = ;
}
else
{
value.Id = list.Max(p => p.Id) + ;
list.Add(value); string url = Url.RouteUrl("getbyid", new { id = value.Id }); Context.Response.StatusCode = ;
//添加成功之后,跳转看是否添加成功
Context.Response.Headers["Location"] = url;
} } //更新数据
// PUT api/values/5
[HttpPut("{id}")]
public IActionResult Put(int id, [FromBody]Test value)
{
if (!ModelState.IsValid)
{
return new HttpStatusCodeResult();
}
else
{
var item = list.FirstOrDefault(p => p.Id.Equals(id)); if (item == null)
{
return HttpNotFound();
}
else
{ value.Id = item.Id; list.Remove(item);
list.Add(value); return new ObjectResult(value);
} }
} //删除数据
// DELETE api/values/5
[HttpDelete("{id}")]
public IActionResult Delete(int id)
{ var item = list.FirstOrDefault(x => x.Id == id);
if (item == null)
{
return HttpNotFound();
}
list.Remove(item);
return new HttpStatusCodeResult();
}
}
}

该注释的我已经注释了。ok 看看效果:

如何在Mvc 6 中创建 Web Api以及如何脱离IIS实现自我托管

我们发现每次f5 运行项目的时候都要通过运行IIS Express 我们才能运行我们的程序,那么有没有可能不通过IIS也能运行我们的程序呢?对于asp.net 5.0 来说答案是肯定的。 我们看一下是怎么做的? asp.net 5.0 可以托管到多种的web server 上 ,这里选择WebListener。即我们可以通过控制台来托管我们程序。

首先在 project.json 中添加Microsoft.AspNet.Server.WebListener包。另外还需要新加一个 "commands" 的设置完整的内容如下:

 {
"webroot": "wwwroot",
"version": "1.0.0-*",
"exclude": [
"wwwroot"
],
"packExclude": [
"**.kproj",
"**.user",
"**.vspscc"
],
"dependencies": {
"Microsoft.AspNet.Server.IIS": "1.0.0-beta1",
"Microsoft.AspNet.Diagnostics": "1.0.0-beta1",
"Microsoft.AspNet.Mvc": "6.0.0-beta1",
"Microsoft.AspNet.Server.WebListener": "1.0.0-beta1"
},
"frameworks": {
"aspnet50": { },
"aspnetcore50": { }
},
"commands": {
"web": "Microsoft.AspNet.Hosting --server Microsoft.AspNet.Server.WebListener --server.urls http://localhost:5000"
} }

然后右键项目属性的debug 选项 设置debug target 为web

如何在Mvc 6 中创建 Web Api以及如何脱离IIS实现自我托管

然后F5运行:

如何在Mvc 6 中创建 Web Api以及如何脱离IIS实现自我托管

这样程序就托管成功了。打开浏览器输入地址:

如何在Mvc 6 中创建 Web Api以及如何脱离IIS实现自我托管

Ok成功了。关于asp.net 5.0 的一些新特性我还在研究,以后我还会发布相关的文章。Asp.net 5.0 这次的变动真的非常的让人激动。