Contracts

Laravel 的契約是一組定義框架提供的核心服務的接口， 例如我們在介紹用戶認證的章節(jié)中到的用戶看守器契約IllumninateContractsAuthGuard 和用戶提供器契約IlluminateContractsAuthUserProvider以及框架自帶的App\User模型所實現(xiàn)的IlluminateContractsAuthAuthenticatable契約。

為什么使用契約

通過上面幾個契約的源碼文件我們可以看到，Laravel提供的契約是為核心模塊定義的一組interface。Laravel為每個契約都提供了相應的實現(xiàn)類，下表列出了Laravel為上面提到的三個契約提供的實現(xiàn)類。

所以在自己開發(fā)的項目中，如果Laravel提供的用戶認證系統(tǒng)無法滿足需求，你可以根據需求定義看守器和用戶提供器的實現(xiàn)類，比如我之前做的項目就是用戶認證依賴于公司的員工管理系統(tǒng)的API，所以我就自己寫了看守器和用戶提供器契約的實現(xiàn)類，讓Laravel通過自定義的Guard和UserProvider來完成用戶認證。自定義用戶認證的方法在介紹用戶認證的章節(jié)中我們介紹過，讀者可以去翻閱那塊的文章。

所以Laravel為所有的核心功能都定義契約接口的目的就是為了讓開發(fā)者能夠根據自己項目的需要自己定義實現(xiàn)類，而對于這些接口的消費者(比如：Controller、或者內核提供的 AuthManager這些)他們不需要關心接口提供的方法具體是怎么實現(xiàn)的， 只關心接口的方法能提供什么功能然后去使用這些功能就可以了，我們可以根據需求在必要的時候為接口更換實現(xiàn)類，而消費端不用進行任何改動。

定義和使用契約

上面我們提到的都是Laravel內核提供的契約， 在開發(fā)大型項目的時候我們也可以自己在項目中定義契約和實現(xiàn)類，你有可能會覺得自帶的Controller、Model兩層就已經足夠你編寫代碼了，憑空多出來契約和實現(xiàn)類會讓開發(fā)變得繁瑣。我們先從一個簡單的例子出發(fā)，考慮下面的代碼有什么問題：

class OrderController extends Controller
{
 public function getUserOrders()
 {
  $orders= Order::where('user_id', '=', \Auth::user()->id)->get();
  return View::make('order.index', compact('orders'));
 }
}

這段代碼很簡單，但我們要想測試這段代碼的話就一定會和實際的數(shù)據庫發(fā)生聯(lián)系。

也就是說， ORM和這個控制器有著緊耦合。如果不使用Eloquent ORM，不連接到實際數(shù)據庫，我們就沒辦法運行或者測試這段代碼。這段代碼同時也違背了“關注分離”這個軟件設計原則。

簡單講：這個控制器知道的太多了。

控制器不需要去了解數(shù)據是從哪兒來的，只要知道如何訪問就行?？刂破饕膊恍枰肋@數(shù)據是從MySQL或哪兒來的，只需要知道這數(shù)據目前是可用的。

Separation Of Concerns 關注分離

Every class should have a single responsibility, and that responsibility should be entirely encapsulated by the class.

每個類都應該只有單一的職責，并且職責里所有的東西都應該由這個類封裝

接下來我們定義一個接口，然后實現(xiàn)該接口

interface OrderRepositoryInterface 
{
 public function userOrders(User $user);
}
class OrderRepository implements OrderRepositoryInterface
{
 public function userOrders(User $user)
 {
  Order::where('user_id', '=', $user->id)->get();
 }
} 

將接口的實現(xiàn)綁定到Laravel的服務容器中

App::singleton('OrderRepositoryInterface', 'OrderRespository'); 　

然后我們將該接口的實現(xiàn)注入我們的控制器

class UserController extends Controller
{
 public function __construct(OrderRepositoryInterface $orderRepository)
 {
  $this->orders = $orderRespository;
 }
 public function getUserOrders()
 {
  $orders = $this->orders->userOrders();
  return View::make('order.index', compact('orders'));
 }
}

現(xiàn)在我們的控制器就完全和數(shù)據層面無關了。在這里我們的數(shù)據可能來自MySQL，MongoDB或者Redis。我們的控制器不知道也不需要知道他們的區(qū)別。這樣我們就可以獨立于數(shù)據層來測試Web層了，將來切換存儲實現(xiàn)也會很容易。

接口與團隊開發(fā)

當你的團隊在開發(fā)大型應用時，不同的部分有著不同的開發(fā)速度。

比如一個開發(fā)人員在開發(fā)數(shù)據層，另一個開發(fā)人員在做控制器層。

寫控制器的開發(fā)者想測試他的控制器，不過數(shù)據層開發(fā)較慢沒法同步測試。那如果兩個開發(fā)者能先以interface的方式達成協(xié)議，后臺開發(fā)的各種類都遵循這種協(xié)議。

一旦建立了約定，就算約定還沒實現(xiàn)，開發(fā)者也可以為這接口寫個“假”實現(xiàn)

class DummyOrderRepository implements OrderRepositoryInterface 
{
 public function userOrders(User $user)
 {
  return collect(['Order 1', 'Order 2', 'Order 3']);
 }
} 

一旦假實現(xiàn)寫好了，就可以被綁定到IoC容器里

App::singleton('OrderRepositoryInterface', 'DummyOrderRepository');

然后這個應用的視圖就可以用假數(shù)據填充了。接下來一旦后臺開發(fā)者寫完了真正的實現(xiàn)代碼，比如叫RedisOrderRepository。

那么使用IoC容器切換接口實現(xiàn)，應用就可以輕易地切換到真正的實現(xiàn)上，整個應用就會使用從Redis讀出來的數(shù)據了。

接口與測試

建立好接口約定后也更有利于我們在測試時進行Mock

public function testIndexActionBindsUsersFromRepository()
{ 
 // Arrange...
 $repository = Mockery::mock('OrderRepositoryInterface');
 $repository->shouldReceive('userOrders')->once()->andReturn(['order1', 'order2]);
 App::instance('OrderRepositoryInterface', $repository);
 // Act...
 $response = $this->action('GET', 'OrderController@getUserOrders');
 // Assert...
 $this->assertResponseOk();
 $this->assertViewHas('order', ['order1', 'order2']);
 } 

總結

接口在程序設計階段非常有用，在設計階段與團隊討論完成功能需要制定哪些接口，然后設計出每個接口具體要實現(xiàn)的方法，方法的入參和返回值這些，每個人就可以按照接口的約定來開發(fā)自己的模塊，遇到還沒實現(xiàn)的接口完全可以先定義接口的假實現(xiàn)等到真正的實現(xiàn)開發(fā)完成后再進行切換，這樣既降低了軟件程序結構中上層對下層的耦合也能保證各部分的開發(fā)進度不會過度依賴其他部分的完成情況。

到此這篇關于解析Laravel框架下的Contracts契約的文章就介紹到這了,更多相關laravel contracts契約 內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

最新評論