Sử dụng WebAPI hoặc MVC để trả về JSON trong ASP.NET

Question

Tôi đang xây dựng một ứng dụng ASP.NET MVC là client-script nặng, nó sẽ sử dụng JSON và jQuery để thao tác DOM.

hiểu biết của tôi là cả hai điều khiển API Web và MVC Controller có thể trở lại JSON.

Với kịch bản của tôi, tôi có nên sử dụng Bộ điều khiển API Web hoặc Bộ điều khiển MVC không?

Answer 1

Bộ điều khiển API Web có thể được tạo và lưu trữ trong bất kỳ Ứng dụng ASP.NET nào, không chỉ các ứng dụng MVC. Vì vậy, một lý do rõ ràng để tạo ra một API Web là nếu bạn không có một mặt trước MVC (ví dụ như các dịch vụ web RESTful được lưu trữ bởi công ty/tổ chức của bạn.)

MVC Bộ điều khiển thường dựa vào khung MVC, nếu bạn nhìn vào các mẫu mặc định và hầu hết công việc được thực hiện bởi cộng đồng và các đồng nghiệp của bạn, bạn sẽ nhận thấy rằng hầu như tất cả các bộ điều khiển MVC đều được thực hiện với chế độ xem.

Cá nhân, tôi sử dụng Bộ điều khiển MVC khi tôi dự định trả lời bằng Chế độ xem() và tôi sẽ sử dụng API Web cho bất kỳ thứ gì không phụ thuộc vào một chế độ xem cụ thể. Dĩ nhiên, hãy cẩn thận nếu bạn không yêu cầu hành vi Ràng buộc mô hình của MVC, dịch vụ của bạn là trung tâm dữ liệu và các hoạt động là trung tâm dữ liệu (ví dụ: hoạt động CRUD) thì bạn có thể muốn 'Bộ điều khiển API Web' thay vì 'Bộ điều khiển kiểu xem'. Ngược lại, nếu hoạt động của bạn là Xem trung tâm (ví dụ:cung cấp một trang quản trị người dùng cho người dùng), hoặc bạn cần Model Binding của MVC để tạo ra 'partj partials' (rất khó), sau đó bạn sẽ muốn có một Controller MVC thay thế.

Cá nhân, tôi sử dụng bộ điều khiển API Web để điều khiển máy khách RESTful dựa trên JSON, tôi sử dụng bộ điều khiển MVC để xử lý định tuyến trình duyệt cơ bản và phân phối SPA.

Answer 2

WebAPI là để tạo API. Nếu bạn muốn ai đó có thể tiêu thụ API của bạn bằng XML, JSON, v.v. Bạn có thể tạo api trên web.

Trong trường hợp của bạn, bạn chỉ cần nói chuyện với khách hàng bằng JSON.

Mặc dù trang web của bạn chủ yếu là tập lệnh của khách hàng nhưng bạn vẫn sẽ sử dụng Bộ điều khiển ASP.NET MVC phải không? Và vì bạn có thể đã phân chia một cách hợp lý các bộ điều khiển của mình dựa trên các thực thể nên việc bổ sung các phương thức phục vụ json đó vào đó là trái ngược với việc tạo ra một lớp đặc biệt cho api web.

Vì vậy, đối với trường hợp cụ thể của bạn (nếu tôi hiểu chính xác), tôi sẽ gắn bó với Bộ điều khiển.

Answer 3

Câu trả lời tóm tắt để phân tách các mối quan tâm, vặn chặt việc tạo dịch vụ và dựa vào quy ước thay vì cấu hình.

Trách nhiệm chính của bộ điều khiển là hoạt động như một điều phối viên giữa chế độ xem và mô hình của bạn nhưng khi trách nhiệm chính của API là làm việc trên dữ liệu. Trong trường hợp các quy ước của API làm cho việc thực hiện các hoạt động CRUD thực sự dễ dàng. Dưới đây là các ánh xạ giữa hoạt động và HTTP hành động CRUD

• GET: Đọc
• POST: Tạo
• PUT: Cập nhật
• DELETE: Xóa

Vì vậy, với API của bạn không có để tạo các hành động riêng biệt và gán chúng với các hành động HTTP.

Answer 4

Mối quan tâm duy nhất tôi có với ApiController là nó dựa trên trang web không dựa trên khu vực. Một trang web chỉ có thể có một thư mục con apicontroller để bạn đặt tên cho các phương thức điều khiển của mình. Có những tình huống bạn có thể muốn lặp lại tên điều khiển trong các lĩnh vực khác nhau:

domain.com/api/area1/controller1/

domain.com/api/area2/controller1/

Tôi nhớ có là một số cài đặt mã tùy chỉnh để có thể thực hiện việc này nhưng nó không hoạt động theo mặc định.

Answer 5

Tôi đồng ý với (câu trả lời đầu) câu trả lời Shaun Wilson nhưng không chắc chắn lý do tại sao như tôi chỉ là một chút bối rối và vẫn đang cố gắng để hiểu như sau (có thể không chính xác) linh cảm -

• Sử dụng WebAPI điều khiển để cung cấp JSON dữ liệu cho khách hàng để khách hàng có thể xử lý các thao tác xem. Quá trình này không yêu cầu chế độ xem mà chỉ là một phản hồi ngược lại với bất kỳ phương thức nào gọi là phương thức (tức là yêu cầu javascript) để khách hàng có thể xử lý bất kỳ thao tác phía máy khách nào.
• Sử dụng bộ điều khiển MVC khi bạn cần sử dụng dữ liệu để thao tác chế độ xem trong hoặc ngay sau khi page_load (nghĩa là không dành cho ứng dụng SPA).

Bạn thấy đấy, tôi không biết làm thế nào tôi không chính xác ở đây và bối rối vì dòng cuối cùng của câu trả lời của Shaun nói "Tôi sử dụng bộ điều khiển MVC để xử lý định tuyến trình duyệt cơ bản và giao hàng SPA." - có lẽ tôi không hoàn toàn biết những gì một khách hàng yên tĩnh là khi tôi giả định nó có thể là phương pháp JavaScript nhận được một phản ứng dưới dạng JSON. đây là bài đăng gần nhất trong Stackoverflow có liên quan từ xa như một câu trả lời cho câu hỏi của tôi vì vậy tôi trả lời bài đăng này thay vì có thể sao chép các câu hỏi.

Answer 6

Trong trường hợp này, tôi muốn giới thiệu WebApi vì nó hoàn hảo cho việc chuyển dữ liệu như vậy dựa trên yêu cầu Javascript. Tôi thường sẽ phát triển các bộ điều khiển WebApi để chúng trả về một đối tượng thân thiện với JSON mà sau đó có thể được phân tích cú pháp dễ dàng bằng Javascript của tôi.

Thời gian thực duy nhất mà bạn muốn sử dụng tác vụ trên bộ điều khiển MVC cho loại điều này sẽ là nếu bạn muốn tạo một số HTML và thay thế các phân đoạn của trang bằng các cuộc gọi Javascript.

Ví dụ:

Bạn có một JQuery UI datepicker rằng khi lựa chọn tạo ra một danh sách các nút radio mà đại diện cho các sự kiện vào ngày lựa chọn.

Trong trường hợp này, bạn có thể sử dụng WebApi để trả về một số JSON và sau đó tạo HTML cần thiết bằng cách sử dụng Javascript nhưng nói chung là thực tiễn không tốt để tạo nhiều HTML bằng cách sử dụng Javascript. Sẽ tốt hơn nếu C# xây dựng HTML và sau đó trả lại nó thông qua một phần xem theo cách này bạn ít có khả năng gặp lỗi với phân tích cú pháp Javascript. Chưa kể nó làm cho HTML dễ viết hơn rất nhiều.