能否在现有ASP.NET MVC 5应用中添加ODataController？路由配置该如何调整？

Absolutely feasible! This is a totally valid approach—you don’t need a separate project to add OData capabilities to your existing ASP.NET MVC 5 app. In fact, leveraging OData’s robust querying directly within your existing domain is a great way to build flexible data-driven views. Below’s a step-by-step guide to configure routing and get everything working smoothly.

Before diving into configuration, install the necessary OData and WebAPI packages via NuGet Package Manager (or Package Manager Console):

Install-Package Microsoft.AspNet.OData
Install-Package Microsoft.AspNet.WebApi.WebHost

Make sure the package versions are compatible with ASP.NET MVC 5 (targeting .NET Framework 4.5 or later).

OData builds on ASP.NET WebAPI, so we’ll set up its routing alongside your existing MVC routes.

Update Global.asax.cs #

Ensure WebAPI/OData routes are registered before MVC routes to avoid conflicts. Your Application_Start method should look like this:

protected void Application_Start()
{
    AreaRegistration.RegisterAllAreas();
    // Register WebAPI/OData first
    GlobalConfiguration.Configure(WebApiConfig.Register);
    FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
    // Then register MVC routes
    RouteConfig.RegisterRoutes(RouteTable.Routes);
    BundleConfig.RegisterBundles(BundleTable.Bundles);
}

Create/Update WebApiConfig.cs #

If you don’t have a WebApiConfig.cs file in the App_Start folder, create it. Add the following code to define your OData model and route:

using System.Web.Http;
using System.Web.OData.Builder;
using System.Web.OData.Extensions;
using YourProjectNamespace.Models; // Replace with your entity model namespace

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // Enable core OData query features ($filter, $select, $orderby, etc.)
        config.Count().Filter().OrderBy().Expand().Select().MaxTop(null);

        // Build your OData entity model
        ODataConventionModelBuilder builder = new ODataConventionModelBuilder();
        // Register your entity sets (maps to ODataControllers)
        // Example: "Products" maps to ProductsController
        builder.EntitySet<Product>("Products");
        // Add other entities or custom model configurations here if needed

        // Register the OData route with a unique prefix (e.g., "odata")
        config.MapODataServiceRoute(
            routeName: "ODataRoute",
            routePrefix: "odata",
            model: builder.GetEdmModel()
        );
    }
}

Create a controller that inherits from ODataController (not the regular MVC Controller). Add the [EnableQuery] attribute to methods that should support OData query parameters:

using System.Web.OData;
using YourProjectNamespace.Models;
using YourProjectNamespace.Data; // Replace with your DbContext namespace

public class ProductsController : ODataController
{
    private readonly YourDbContext _dbContext = new YourDbContext();

    // Return all Products with OData query support
    [EnableQuery]
    public IQueryable<Product> Get()
    {
        return _dbContext.Products;
    }

    // Get a single Product by ID (with OData query support)
    [EnableQuery]
    public SingleResult<Product> Get([FromODataUri] int key)
    {
        var result = _dbContext.Products.Where(p => p.Id == key);
        return SingleResult.Create(result);
    }

    // Add Post/Put/Patch/Delete methods if you need CRUD functionality
}

You can now make AJAX requests from your CSHTML views to the OData endpoint to fetch filtered/sorted data. Here’s a quick example using jQuery:

<div id="productList"></div>

<script src="~/Scripts/jquery-3.6.0.min.js"></script>
<script>
// Example: Fetch products where Price > 10, only return Name and Price
$.ajax({
    url: "/odata/Products?$filter=Price gt 10&$select=Name,Price",
    type: "GET",
    dataType: "json",
    success: function(response) {
        // OData returns results in the "value" property
        const products = response.value;
        let html = "";
        products.forEach(product => {
            html += `<div class="product-item">${product.Name}: $${product.Price}</div>`;
        });
        $("#productList").html(html);
    },
    error: function(xhr) {
        console.error("Error fetching data:", xhr.responseText);
    }
});
</script>

• Unique Route Prefix: Using a prefix like "odata" ensures OData routes don’t clash with your existing MVC routes (e.g., if you have an MVC ProductsController, the OData endpoint will be /odata/Products instead of /Products).
• Registration Order: Always register WebAPI/OData routes before MVC routes—otherwise, MVC’s catch-all route will intercept OData requests.
• [EnableQuery] Attribute: Don’t forget this on your ODataController methods—it’s what enables the OData query syntax.
• DbContext Best Practices: For production, use dependency injection to manage your DbContext instead of instantiating it directly in the controller.

内容的提问来源于stack exchange，提问作者Thomas.Benz