Maison >développement back-end >tutoriel php >Créer du code PHP testable et maintenable
Les frameworks fournissent les outils nécessaires au développement rapide d'applications, mais augmentent souvent la dette technique à mesure que vous créez des fonctionnalités rapidement. La dette technique survient lorsque la maintenabilité n’est pas une priorité pour les développeurs. Les modifications futures et le débogage sont coûteux en raison du manque de tests unitaires et de structure.
Voici comment commencer à structurer votre code pour la testabilité et la maintenabilité - et vous faire gagner du temps.
Commençons par un code artificiel mais typique. Cela pourrait être une classe modèle dans n’importe quel framework donné.
class User { public function getCurrentUser() { $user_id = $_SESSION['user_id']; $user = App::db->select('id, username') ->where('id', $user_id) ->limit(1) ->get(); if ( $user->num_results() > 0 ) { return $user->row(); } return false; } }
Ce code fonctionne mais doit être amélioré :
$_SESSION
全局变量。单元测试框架(例如 PHPUnit)依赖于命令行,其中 $_SESSION
et de nombreuses autres variables globales qui ne sont pas disponibles. App::db
instance utilisée dans l'application. De plus, que se passe-t-il si nous ne voulons pas les informations de l'utilisateur actuel ? Voici une tentative de création d'un test unitaire pour la fonctionnalité ci-dessus.
class UserModelTest extends PHPUnit_Framework_TestCase { public function testGetUser() { $user = new User(); $currentUser = $user->getCurrentUser(); $this->assertEquals(1, $currentUser->id); } }
Vérifions ça. Premièrement, le test échouera. User
对象中使用的 $_SESSION
La variable n'existe pas dans le test unitaire car elle exécute PHP depuis la ligne de commande.
Deuxièmement, il n'y a pas de configuration de connexion à la base de données. Cela signifie que, pour que cela fonctionne, nous devons amorcer notre application pour obtenir l'objet App
对象及其 db
. Nous avons également besoin d'une connexion à la base de données fonctionnelle pour tester.
Pour faire fonctionner ce test unitaire, nous avons besoin de :
Alors, commençons par discuter de la façon d’améliorer cela.
Dans ce contexte simple, la fonction permettant de récupérer l'utilisateur actuel est inutile. Il s'agit d'un exemple artificiel, mais dans l'esprit du principe DRY, la première optimisation que j'ai choisi de faire a été de généraliser cette approche.
class User { public function getUser($user_id) { $user = App::db->select('user') ->where('id', $user_id) ->limit(1) ->get(); if ( $user->num_results() > 0 ) { return $user->row(); } return false; } }
Cela fournit une méthode que nous pouvons utiliser tout au long de notre application. Au lieu de transmettre la fonction au modèle, nous pouvons transmettre l'utilisateur actuel lors de l'appel. Le code est plus modulaire et maintenable lorsqu'il ne dépend pas d'autres fonctionnalités, telles que les variables globales de session.
Cependant, cela ne peut toujours pas être testé et maintenu comme prévu. Nous comptons toujours sur les connexions aux bases de données.
Contribuons à améliorer cette situation en ajoutant une injection de dépendances. Lorsque nous transmettons la connexion à la base de données dans la classe, notre modèle pourrait ressembler à ceci.
class User { protected $_db; public function __construct($db_connection) { $this->_db = $db_connection; } public function getUser($user_id) { $user = $this->_db->select('user') ->where('id', $user_id) ->limit(1) ->get(); if ( $user->num_results() > 0 ) { return $user->row(); } return false; } }
Maintenant, les dépendances de notre User
modèle sont fournies. Nos classes ne supposent plus une certaine connexion à une base de données et ne dépendent d'aucun objet global.
À ce stade, notre classe est pratiquement prête pour les tests. Nous pouvons transmettre la source de données de notre choix (principalement) et l'ID utilisateur, et tester les résultats de cet appel. Nous pouvons également permuter des connexions de bases de données distinctes (en supposant que les deux implémentent la même méthode de récupération de données). cool.
Voyons à quoi pourraient ressembler les tests unitaires.
<?php use Mockery as m; use Fideloper\User; class SecondUserTest extends PHPUnit_Framework_TestCase { public function testGetCurrentUserMock() { $db_connection = $this->_mockDb(); $user = new User( $db_connection ); $result = $user->getUser( 1 ); $expected = new StdClass(); $expected->id = 1; $expected->username = 'fideloper'; $this->assertEquals( $result->id, $expected->id, 'User ID set correctly' ); $this->assertEquals( $result->username, $expected->username, 'Username set correctly' ); } protected function _mockDb() { // "Mock" (stub) database row result object $returnResult = new StdClass(); $returnResult->id = 1; $returnResult->username = 'fideloper'; // Mock database result object $result = m::mock('DbResult'); $result->shouldReceive('num_results')->once()->andReturn( 1 ); $result->shouldReceive('row')->once()->andReturn( $returnResult ); // Mock database connection object $db = m::mock('DbConnection'); $db->shouldReceive('select')->once()->andReturn( $db ); $db->shouldReceive('where')->once()->andReturn( $db ); $db->shouldReceive('limit')->once()->andReturn( $db ); $db->shouldReceive('get')->once()->andReturn( $result ); return $db; } }
J'ai ajouté quelque chose de nouveau à ce test unitaire : la moquerie. La moquerie vous permet de « vous moquer » (de faux) des objets PHP. Dans cet exemple, nous simulons une connexion à une base de données. Avec notre simulation, nous pouvons ignorer le test de la connexion à la base de données et simplement tester notre modèle.
Vous voulez en savoir plus sur la moquerie ?
Dans cet exemple, nous simulons une connexion SQL. Nous disons à l'objet fictif d'attendre un appel à l'objet select
、where
、limit
和 get
方法。我返回 Mock 本身,以反映 SQL 连接对象如何返回自身 ($this
),从而使其方法调用“可链接”。请注意,对于 get
方法,我返回数据库调用结果 - 填充了用户数据的 stdClass
.
Cela résout certains problèmes :
我们还可以做得更好。这就是它变得有趣的地方。
为了进一步改进这一点,我们可以定义并实现一个接口。考虑以下代码。
interface UserRepositoryInterface { public function getUser($user_id); } class MysqlUserRepository implements UserRepositoryInterface { protected $_db; public function __construct($db_conn) { $this->_db = $db_conn; } public function getUser($user_id) { $user = $this->_db->select('user') ->where('id', $user_id) ->limit(1) ->get(); if ( $user->num_results() > 0 ) { return $user->row(); } return false; } } class User { protected $userStore; public function __construct(UserRepositoryInterface $user) { $this->userStore = $user; } public function getUser($user_id) { return $this->userStore->getUser($user_id); } }
这里发生了一些事情。
addUser()
方法。User
模型中强制使用实现 UserInterface
的类。这样可以保证数据源始终有一个可用的 getUser()
方法,无论使用哪个数据源来实现 UserInterface
。请注意,我们的
User
对象类型提示UserInterface
在其构造函数中。这意味着实现UserInterface
的类必须传递到User
对象中。这是我们所依赖的保证 - 我们需要getUser
方法始终可用。
这样做的结果是什么?
User
类,我们可以轻松地模拟数据源。 (测试数据源的实现将是单独的单元测试的工作)。User
对象。如果您决定放弃 SQL,则只需创建一个不同的实现(例如 MongoDbUser
)并将其传递到您的 User
模型中。我们还简化了单元测试!
<?php use Mockery as m; use Fideloper\User; class ThirdUserTest extends PHPUnit_Framework_TestCase { public function testGetCurrentUserMock() { $userRepo = $this->_mockUserRepo(); $user = new User( $userRepo ); $result = $user->getUser( 1 ); $expected = new StdClass(); $expected->id = 1; $expected->username = 'fideloper'; $this->assertEquals( $result->id, $expected->id, 'User ID set correctly' ); $this->assertEquals( $result->username, $expected->username, 'Username set correctly' ); } protected function _mockUserRepo() { // Mock expected result $result = new StdClass(); $result->id = 1; $result->username = 'fideloper'; // Mock any user repository $userRepo = m::mock('Fideloper\Third\Repository\UserRepositoryInterface'); $userRepo->shouldReceive('getUser')->once()->andReturn( $result ); return $userRepo; } }
我们已经完全取消了模拟数据库连接的工作。相反,我们只是模拟数据源,并告诉它当调用 getUser
时要做什么。
但是,我们仍然可以做得更好!
考虑我们当前代码的用法:
// In some controller $user = new User( new MysqlUser( App:db->getConnection("mysql") ) ); $user->id = App::session("user->id"); $currentUser = $user->getUser($user_id);
我们的最后一步是引入容器。容器。在上面的代码中,我们需要创建并使用一堆对象来获取当前用户。此代码可能散布在您的应用程序中。如果您需要从 MySQL 切换到 MongoDB,您仍然需要编辑上述代码出现的每个位置。那几乎不是干的。容器可以解决这个问题。
容器只是“包含”一个对象或功能。它类似于应用程序中的注册表。我们可以使用容器自动实例化一个新的 User
对象以及所有需要的依赖项。下面,我使用 Pimple,一个流行的容器类。
// Somewhere in a configuration file $container = new Pimple(); $container["user"] = function() { return new User( new MysqlUser( App:db->getConnection('mysql') ) ); } // Now, in all of our controllers, we can simply write: $currentUser = $container['user']->getUser( App::session('user_id') );
我已将 User
模型的创建移至应用程序配置中的一个位置。结果是:
User
对象和选择的数据存储在我们应用程序的一个位置定义。User
模型从使用 MySQL 切换到 ONE 位置中的任何其他数据源。这更易于维护。在本教程的过程中,我们完成了以下任务:
我相信您已经注意到,我们以可维护性和可测试性的名义添加了更多代码。可以对这种实现提出强有力的论据:我们正在增加复杂性。事实上,这需要项目的主要作者和合作者对代码有更深入的了解。
但是,技术债务总体减少远远超过了解释和理解的成本。
您可以使用 Composer 轻松地将 Mockery 和 PHPUnit 包含到您的应用程序中。将这些添加到 composer.json
文件中的“require-dev”部分:
"require-dev": { "mockery/mockery": "0.8.*", "phpunit/phpunit": "3.7.*" }
然后,您可以按照“dev”要求安装基于 Composer 的依赖项:
$ php composer.phar install --dev
在 Nettuts+ 上了解有关 Mockery、Composer 和 PHPUnit 的更多信息。
对于 PHP,请考虑使用 Laravel 4,因为它特别利用了容器和此处介绍的其他概念。
感谢您的阅读!
Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!