vs2012 + web api + OData + EF + MYsql

vs2012 + web api + OData + EF + MYsql 开发及部署

先说下我的情况，b/s开发这块已经很久没有搞了，什么web api 、MVC、OData都只是听过，没有实际开发过，因为最近要开发一个手机app的服务端，所以准备用这套框架来开发。

下面开始进入正题（我尽量将自己开始写代码遇到的所有问题还原，以便以后提醒自己，文章是在我开发部署完毕后开始写的，所以有些地方有遗漏，还请见谅）

1：首先用vs2012新建一个“asp.net 空 web 应用程序”，（注意，我选择的是.net 4.0版本，原因后面会解释）

2：这个时候项目应该是空白的一片，什么都没有。首先我们要在项目引用中添加几个dll的引用“System.Web.Http,System.Web.Http.WebHost,System.Net.Http,Newtonsoft.Json”

　　除了Newtonsoft.Json，其他三个dll可以直接在引用里面找到，Newtonsoft.Json需要用“程序包管理器控制台”来加载，命令如下“install-package Newtonsoft.Json”,不区分大小写

3：创建model、controller文件，在项目中的位置自己定义，文件代码内容如下:

    public class User
    {
        public string UserID { get; set; }
        public string UserName { get; set; }
    }

 public class UserController : ApiController
    {
        public User Get()
        {
            return new User() { UserID = "000", UserName = "Admin" };
        }

        public bool add(User user)
        {
            return user != null;
        }
    }

（以上代码是我在网上找demo时搜到的，并非自己原创，大家见谅）

3：创建路由规则，（这块应该是属于MVC的知识，只是以前由vs自动创建，现在由自己手写）

定义一个类

public class WebApiConfig
{
        public static void Register(HttpConfiguration config)
        {
            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/{controller}/{id}",
                defaults: new { id = RouteParameter.Optional }
            );
        }
 }

然后自己手动添加一个Global文件，并添加以下代码

protected void Application_Start(object sender, EventArgs e)
{
    WebApiConfig.Register(GlobalConfiguration.Configuration);
}

Ok，到这里为止，一个由vs2012创建的web api程序已经完成。

启动vs，在浏览器输入“localhost:端口号/api/user”就可以访问了

（以上代码参考网络资料，请原谅我忘记原始地址了.）

一直到上面的代码，都很顺利，至少我在开发的过程中没有遇到过问题，下面开始，就会出现各种问题。

现在开始添加对OData的支持，利用NuGet来添加对OData的支持

如图，会出现两个选择，一个是v1-3，一个是v4版本的。这里我选择的是v1-3的，因为听说v4版本好像还不太稳定。

（说一下我在这里遇到的问题，一开始创建项目时选择的是.net 4.0版本的，如果选择的是4.5默认版本的话，添加 Odata v4版本会提示对4.5不支持之类的信息，如果添加OData v1-3版本的话，在添加成功后，运行项目，

这时候项目时会报错的，请原谅我才疏学浅，没有搞清楚是什么原因就放弃了。因为我发现使用.net 4.0版本添加OData v1-3项目是不报错的，当然这也是我试过很多解决方法后解决的）

添加OData组件后，需要在项目中做一些修改，针对Controller文件，将UserController的代码修改如下：

[Queryable]
public IQueryable<User> get() {
    return new User[] { new User() { UserID = "000", UserName = "Admin" } }.AsQueryable();
}

ok，就是这么简单，现在可以在浏览器中浏览数据了，我这里只做了一条数据，所以浏览时看不出什么效果

如果多做几条数据，用如下url是可以正确访问的：

localhost:端口/api/user?$top2

localhost:端口/api/user?$filter=UserId eq '000'

请注意一点，OData是大小写敏感的。

OK，下面开始用EF添加对Mysql的支持。

首先需要下载安装组件：“mysql-connector-net-6.6.7.msi” ，这个在官网上下载就好了，不过要注册，有点麻烦.

然后安装ef，使用“程序包管理器控制台”来加载，命令如下“install-package entityframework”,

安装好之后，重启vs，在项目里面选择“新建项”

如图选择，填好名称，点击添加

这里有些版本的选择会不一样，我的只有这两个选项，选择“从数据库生成”即可，点击下一步

这里填写你的Mysql的ip、用户名、密码确定即可。

（在安装“mysql-connector-net-6.6.7.msi” 时，如果你的开发机器安装过mysql的相关软件，可能会出一些问题，一般是在“程序和功能”中将原来的删除掉，

安装新的就可以了，不然会在选择数据源时，没有“Mysql database”这个选项）

这时在项目中会出现一个“*.edmx”文件，这就是ef创建的文件

这时新建一个Controller文件，自己随意命名，代码如下：

public class ProductController : ApiController
    {
        [Queryable(AllowedOrderByProperties = "id", AllowedQueryOptions = AllowedQueryOptions.All)]
        public IQueryable<map_goodsdiscount> Get()
        {
            var db = new testEntities();
            return db.map_goodsdiscount.AsQueryable();
        }
    }

其中：

map_goodsdiscount是你在Mysql中对应的数据表名称，

testEntities是你用EF建Mysql数据源填写的名称

Queryable属性中AllowedOrderByProperties 表示默认排序按照“id”字段

AllowedQueryOptions 属性控制Odata查询条件，比如

到这里为止，所有代码都已经写完，如果有什么遗漏的，发现之后，我再添加上去。

下面开始部署，部署环境为windows server 2008 r2，已经安装4.0环境，这里将部署时注意的事项一并列出来
1：项目中ef的版本问题，默认是4.5的，部署时需要删除entityframework引用，并添加4.0版本的dll，我本机的4.0地址为：

C:\Program Files (x86)\Microsoft Web Tools\Packages\EntityFramework.5.0.0\lib\net40
修改配置文件web.config为如下格式：

<section name="entityFramework" type="System.Data.Entity.Internal.ConfigFile.EntityFrameworkSection, EntityFramework, Version=5.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" />

<section name="entityFramework" type="System.Data.Entity.Internal.ConfigFile.EntityFrameworkSection, EntityFramework, Version=4.4.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" />

2：如果在部署的时候遇到404错误，添加以下代码在web.config

<system.webServer>
　　<validation validateIntegratedModeConfiguration="false" />
　　<modules runAllManagedModulesForAllRequests="true" />
    <handlers>
　　　　<remove name="ExtensionlessUrlHandler-Integrated-4.0" />
　　　　<add name="ExtensionlessUrlHandler-Integrated-4.0" path="*." verb="*" type="System.Web.Handlers.TransferRequestHandler" resourceType="Unspecified" requireAccess="Script" preCondition="integratedMode,runtimeVersionv4.0" />
    </handlers>
  </system.webServer>

一直到这里，我的项目从开发到部署就已经全部完成了，其中出了很多问题，都是网上找的资料，加上自己的一点点经验解决的，希望对其他人会有一点点帮助。

 

 

标签: web api ef odata mysql