ความแตกต่างระหว่าง ApiController และคอนโทรลเลอร์ใน ASP.NET MVC

ฉันได้รับการเล่นรอบกับ ASP.NET MVC 4 รุ่นเบต้าและผมเห็นสองประเภทของการควบคุมขณะนี้: และApiControllerController

ฉันสับสนเล็กน้อยว่าสถานการณ์ใดที่ฉันสามารถเลือกคอนโทรลเลอร์ได้

ตัวอย่างเช่น: ถ้าฉันต้องการส่งคืนมุมมองฉันต้องใช้ApiControllerหรือControllerไม่? ฉันทราบว่า WCF Web API ได้รวมเข้ากับ MVC แล้ว

ตั้งแต่ตอนนี้เราสามารถใช้ตัวควบคุมทั้งสองได้ใครสักคนโปรดชี้ไปที่สถานการณ์ที่จะไปสำหรับตัวควบคุมที่เกี่ยวข้อง

ใช้ตัวควบคุมเพื่อแสดงมุมมองปกติของคุณ การกระทำของ ApiController จะส่งคืนข้อมูลที่ต่อเนื่องและส่งไปยังไคลเอนต์เท่านั้น

นี่คือลิงค์

อ้างถึง:

หมายเหตุถ้าคุณทำงานกับ ASP.NET MVC แสดงว่าคุณคุ้นเคยกับคอนโทรลเลอร์แล้ว พวกมันทำงานคล้ายกันใน Web API แต่ตัวควบคุมใน Web API สืบทอดมาจากคลาส ApiController แทนคลาส Controller ความแตกต่างที่สำคัญอันดับแรกที่คุณจะสังเกตเห็นคือการกระทำบนตัวควบคุม Web API จะไม่ส่งคืนมุมมอง แต่จะส่งคืนข้อมูล

ApiControllers มีความเชี่ยวชาญในการส่งคืนข้อมูล ตัวอย่างเช่นพวกเขาดูแลข้อมูลที่เป็นลำดับอย่างโปร่งใสในรูปแบบที่ลูกค้าร้องขอ นอกจากนี้พวกเขายังทำตามรูปแบบการกำหนดเส้นทางที่แตกต่างกันตามค่าเริ่มต้น (ใน: การจับคู่ URL กับการกระทำ) โดยให้ REST-ful API ตามการประชุม

คุณสามารถทำอะไรก็ได้โดยใช้คอนโทรลเลอร์แทน ApiController ที่มีการเข้ารหัสด้วยตนเอง (?) ในท้ายที่สุดตัวควบคุมทั้งสองจะสร้างบนพื้นฐาน ASP.NET แต่การมี REST-ful API นั้นเป็นข้อกำหนดทั่วไปในปัจจุบันที่ WebAPI ถูกสร้างขึ้นเพื่อทำให้การใช้ API นั้นง่ายขึ้น

มันค่อนข้างง่ายในการตัดสินใจระหว่างสอง: ถ้าคุณกำลังเขียนแอปพลิเคชันบนเว็บ / อินเทอร์เน็ต / อินทราเน็ต HTML - บางทีด้วยการโทร AJAX ที่กลับมาเป็นครั้งคราว json ที่นี่และที่นั่น - ติดกับ MVC / Controller หากคุณต้องการจัดเตรียมข้อมูลที่ขับเคลื่อนด้วย / REST-ful ส่วนต่อประสานกับระบบให้ไปที่ WebAPI คุณสามารถรวมทั้งสองอย่างเข้าด้วยกันโดยให้ ApiController ตอบสนองการโทร AJAX จากหน้า MVC

เพื่อยกตัวอย่างโลกแห่งความจริง: ขณะนี้ฉันกำลังทำงานกับระบบ ERP ที่ให้ REST-ful API แก่หน่วยงานของตน สำหรับ API นี้ WebAPI จะเป็นตัวเลือกที่ดี ในขณะเดียวกันระบบ ERP ยังมีแอปพลิเคชั่นเว็บ AJAX-ified สูงซึ่งคุณสามารถใช้เพื่อสร้างคิวรีสำหรับ REST-ful API เว็บแอปพลิเคชันสามารถนำไปใช้เป็นแอปพลิเคชั่น MVC โดยใช้ WebAPI เพื่อดึงข้อมูลเมตาเป็นต้น

คุณอยากเขียนและบำรุงรักษาแบบไหน

ASP.NET MVC

public class TweetsController : Controller {
  // GET: /Tweets/
  [HttpGet]
  public ActionResult Index() {
    return Json(Twitter.GetTweets(), JsonRequestBehavior.AllowGet);
  }
}

ASP.NET Web API

public class TweetsController : ApiController {
  // GET: /Api/Tweets/
  public List<Tweet> Get() {
    return Twitter.GetTweets();
  }
}

ฉันชอบความจริงที่ว่า MVC6 ของ ASP.NET Core ได้รวมสองรูปแบบเข้าด้วยกันเพราะฉันมักจะต้องการการสนับสนุนทั้งสองโลก ในขณะที่มันเป็นความจริงที่คุณสามารถปรับแต่ง MVC มาตรฐานใด ๆController(และ / หรือพัฒนาActionResultชั้นเรียนของคุณเอง) เพื่อทำหน้าที่และประพฤติเหมือนApiControllerมันอาจเป็นเรื่องยากมากที่จะรักษาและทดสอบ: นอกเหนือจากนั้นมีวิธีควบคุมกลับActionResultผสมกับผู้อื่น การส่งคืนข้อมูลดิบ / ต่อเนื่อง / IHttpActionResultข้อมูลอาจสร้างความสับสนอย่างมากจากมุมมองของนักพัฒนาโดยเฉพาะอย่างยิ่งหากคุณไม่ได้ทำงานคนเดียวและต้องทำให้นักพัฒนาซอฟต์แวร์รายอื่น ๆ

เทคนิคที่ดีที่สุดที่ฉันใช้มาจนถึงตอนนี้เพื่อลดปัญหาดังกล่าวในแอปพลิเคชันเว็บที่ไม่ใช่คอร์ ASP.NET คือการนำเข้า (และกำหนดค่าอย่างเหมาะสม) แพ็คเกจเว็บ API ลงในแอปพลิเคชันบนเว็บที่ใช้ MVC ดังนั้นฉันจึง โลก: Controllersสำหรับ Views ApiControllersสำหรับข้อมูล

ในการทำเช่นนั้นคุณต้องทำสิ่งต่อไปนี้:

• ติดตั้งแพคเกจดังต่อไปนี้ API เว็บโดยใช้ NuGet: และMicrosoft.AspNet.WebApi.CoreMicrosoft.AspNet.WebApi.WebHost
• เพิ่ม ApiControllers หนึ่งรายการขึ้นไปใน/Controllers/โฟลเดอร์ของคุณ
• เพิ่มไฟล์WebApiConfig.csต่อไปนี้ใน/App_Config/โฟลเดอร์ของคุณ:

using System.Web.Http;

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // Web API routes
        config.MapHttpAttributeRoutes();

        config.Routes.MapHttpRoute(
            name: "DefaultApi",
            routeTemplate: "api/{controller}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );
    }
}

ท้ายสุดคุณจะต้องลงทะเบียนคลาสข้างต้นในคลาสเริ่มต้นของคุณ( Startup.csหรือGlobal.asax.csขึ้นอยู่กับว่าคุณใช้เทมเพลตการเริ่มต้น OWIN หรือไม่)

Startup.cs

 public void Configuration(IAppBuilder app)
 {
    // Register Web API routing support before anything else
    GlobalConfiguration.Configure(WebApiConfig.Register);

    // The rest of your file goes there
    // ...
    AreaRegistration.RegisterAllAreas();
    FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
    RouteConfig.RegisterRoutes(RouteTable.Routes);
    BundleConfig.RegisterBundles(BundleTable.Bundles);

    ConfigureAuth(app);
    // ...
}

Global.asax.cs

protected void Application_Start()
{
    // Register Web API routing support before anything else
    GlobalConfiguration.Configure(WebApiConfig.Register);

    // The rest of your file goes there
    // ...
    AreaRegistration.RegisterAllAreas();
    FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
    RouteConfig.RegisterRoutes(RouteTable.Routes);
    BundleConfig.RegisterBundles(BundleTable.Bundles);
    // ...
}

วิธีการนี้ - พร้อมกับข้อดีและข้อเสีย - อธิบายเพิ่มเติมในโพสต์นี้ที่ฉันเขียนไว้ในบล็อกของฉัน

ทุกวิธีใน Web API จะส่งคืนข้อมูล (JSON) โดยไม่มีการทำให้เป็นอนุกรม

อย่างไรก็ตามในการส่งคืนข้อมูล JSON ในตัวควบคุม MVC เราจะตั้งค่าประเภทผลลัพธ์การดำเนินการที่ส่งคืนเป็น JsonResult และเรียกวิธีการ Json บนวัตถุของเราเพื่อให้แน่ใจว่าบรรจุใน JSON

ข้อแตกต่างที่สำคัญคือ: Web API เป็นบริการสำหรับลูกค้าอุปกรณ์ใด ๆ และตัวควบคุม MVC ให้บริการลูกค้าเท่านั้น เหมือนกันเพราะมันเป็นแพลตฟอร์ม MVC

มันค่อนข้างง่ายในการตัดสินใจระหว่างสอง: ถ้าคุณกำลังเขียนแอปพลิเคชันบนเว็บ / อินเทอร์เน็ต / อินทราเน็ต HTML - บางทีด้วยการโทร AJAX ที่กลับมาเป็นครั้งคราว json ที่นี่และที่นั่น - ติดกับ MVC / Controller หากคุณต้องการจัดเตรียมข้อมูลที่ขับเคลื่อนด้วย / REST-ful ส่วนต่อประสานกับระบบให้ไปที่ WebAPI คุณสามารถรวมทั้งสองอย่างเข้าด้วยกันโดยให้ ApiController ตอบสนองการโทร AJAX จากหน้า MVC โดยทั่วไปคอนโทรลเลอร์ใช้สำหรับ mvc และ api-controller ใช้สำหรับ Rest- API คุณสามารถใช้ทั้งในโปรแกรมเดียวกับที่คุณต้องการ