18、构建与分发模块化电商应用

构建与分发模块化电商应用

在开发电商应用时，模块化开发是一种高效且易于维护的方式。本文将详细介绍如何构建一个简单的销售模块，并探讨如何通过Git和Composer来集成和分发这些模块。

销售模块的构建与测试

销售模块是电商应用中的核心部分，它允许客户进行购物车操作和结账。为了确保模块的质量，我们需要进行单元测试和功能测试。

单元测试

单元测试主要针对 CustomerOrders 服务。以下是具体步骤：
1. 在 phpunit.xml.dist 文件的 testsuites 元素下添加测试目录：

<directory>src/Foggyline/SalesBundle/Tests</directory>

2. 创建 CustomerOrdersTest.php 文件，内容如下：

namespace Foggyline\SalesBundle\Test\Service;
use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
use Symfony\Component\Security\Core\Authentication\ 
  Token\UsernamePasswordToken;
class CustomerOrdersTest extends KernelTestCase
{
  private $container;
  public function setUp()
  {
    static::bootKernel();
    $this->container = static::$kernel->getContainer();
  }
  public function testGetOrders()
  {
    $firewall = 'foggyline_customer';
    $em = $this->container->get 
      ('doctrine.orm.entity_manager');
    $user = $em->getRepository 
      ('FoggylineCustomerBundle:Customer')->findOneByUsername
      ('ajzele@gmail.com');
    $token = new UsernamePasswordToken($user, null, $firewall,  
      array('ROLE_USER'));
    $tokenStorage = $this->container->get 
      ('security.token_storage');
    $tokenStorage->setToken($token);
    $orders = new \Foggyline\SalesBundle\Service 
      \CustomerOrders(
      $em,
      $tokenStorage,
      $this->container->get('router')
    );
    $this->assertNotEmpty($orders->getOrders());
  }
}

这里使用 UsernamePasswordToken 函数模拟客户登录，将密码令牌传递给 CustomerOrders 服务，该服务会检查令牌存储是否有分配的令牌，以确定用户是否已登录并返回订单列表。

功能测试

功能测试主要测试将产品添加到购物车并访问结账页面的流程。以下是具体步骤：
1. 创建 CartControllerTest.php 文件，内容如下：

namespace Foggyline\SalesBundle\Tests\Controller;
use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
use Symfony\Component\BrowserKit\Cookie;
use Symfony\Component\Security\Core\Authentication\ 
Token\UsernamePasswordToken;
class CartControllerTest extends WebTestCase
{
  private $client = null;
  public function setUp()
  {
    $this->client = static::createClient();
  }
  public function testAddToCartAndAccessCheckout()
  {
    $this->logIn();
    $crawler = $this->client->request('GET', '/');
    $crawler = $this->client->click($crawler->selectLink('Add  
      to Cart')->link());
    $crawler = $this->client->followRedirect();
    $this->assertTrue($this->client->getResponse()-> 
      isSuccessful());
    $this->assertGreaterThan(0, $crawler->filter 
      ('html:contains("added to cart")')->count());
    $crawler = $this->client->request('GET', '/sales/cart/');
    $crawler = $this->client->click($crawler->selectLink('Go  
      to Checkout')->link());
    $this->assertTrue($this->client->getResponse()-> 
      isSuccessful());
    $this->assertGreaterThan(0, $crawler->filter 
      ('html:contains("Checkout")')->count());
  }
  private function logIn()
  {
    $session = $this->client->getContainer()->get('session');
    $firewall = 'foggyline_customer'; // firewall name
    $em = $this->client->getContainer()->get('doctrine')-> 
      getManager();
    $user = $em->getRepository 
      ('FoggylineCustomerBundle:Customer')->findOneByUsername 
      ('ajzele@gmail.com');
    $token = new UsernamePasswordToken($user, null, $firewall,  
      array('ROLE_USER'));
    $session->set('_security_' . $firewall,  
      serialize($token));
    $session->save();
    $cookie = new Cookie($session->getName(), $session-> 
      getId());
    $this->client->getCookieJar()->set($cookie);
  }
}

运行该测试时，会模拟客户登录，将商品添加到购物车，并尝试访问结账页面。根据数据库中的实际客户情况，可能需要更改测试中提供的客户电子邮件。运行 phpunit 命令即可执行这些测试。

模块的集成与分发

为了更好地管理和分发我们的模块，我们可以使用Git和Composer。

使用Git进行模块管理

Git是一种流行的版本控制系统，我们可以使用其 submodules 功能将应用程序拆分为多个子模块。具体步骤如下：
1. 创建核心仓库 ：

cp -R shop core-repository
rm -Rf core-repository/.git/
rm -Rf core-repository/src/Foggyline/*
touch core-repository/src/Foggyline/.gitkeep
cd core-repository
git init
git remote add origin git@github.com:<user>/<core-repository>.git
git add --all
git commit -m "Initial commit of core application"
git push origin master

2. 创建模块仓库 ：以 CatalogBundle 为例：

cp -R shop/src/Foggyline/CatalogBundle catalog-repository
cd catalog-repository
git init
git remote add origin git@github.com:<user>/<catalog-repository>.git
git add --all
git commit -m "Initial commit of catalog module"
git push origin master

3. 添加子模块 ：

cd core-repository
git submodule add git@github.com:<user>/<catalog-repository>.git  src/Foggyline/CatalogBundle
git submodule add git@github.com:<user>/<customer-repository>.git  src/Foggyline/CustomerBundle
git submodule add git@github.com:<user>/<payment-repository>.git  src/Foggyline/PaymentBundle
git submodule add git@github.com:<user>/<sales-repository>.git  src/Foggyline/SalesBundle
git submodule add git@github.com:<user>/<shipment-repository>.git  src/Foggyline/ShipmentBundle

4. 提交 .gitmodules 文件 ：运行 ls -al 命令可以看到 .gitmodules 文件，提交该文件到核心仓库：

git add .gitmodules
git commit -m "Add .gitmodules file"
git push origin master

5. 克隆项目 ：使用 --recursive 参数克隆项目，自动初始化和更新子模块：

git clone --recursive git@github.com:<user>/<core-repository>.git

使用Composer进行依赖管理

Composer是PHP的依赖管理工具，我们可以使用它来定义项目的依赖项。具体步骤如下：
1. 创建 composer.json 文件 ：

{
"require": {
"twig/twig": "~1.0"
    }
}

2. 安装依赖项 ：在包含 composer.json 文件的目录中运行 composer install 命令：

composer install

该命令会下载所需的代码到本地，并创建 composer.lock 文件记录安装的依赖项版本。

使用Packagist分发模块

Packagist是Composer包的主要仓库，我们可以将模块发布到该仓库。具体步骤如下：
1. 创建 composer.json 文件 ：以 CatalogBundle 为例：

{
"name": "foggyline/catalogbundle",
"version" : "1.0.0",
"type": "library",
"description": "Just a test module for web shop application.",
"keywords": [
"catalog"
  ],
"homepage": "https://github.com/ajzele/B05460_CatalogBundle",
"license": "MIT",
"authors": [
    {
"name": "Branko Ajzele",
"email": "ajzele@gmail.com",
"homepage": "http://foggyline.net",
"role": "Developer"
    }
  ],
"minimum-stability": "dev",
"prefer-stable": true,
"autoload": {
"psr-0": {
"Foggyline\\CatalogBundle\\": ""
    }
  },
"target-dir": "Foggyline/CatalogBundle"
}

2. 提交到Packagist ：登录Packagist，点击 Submit 按钮，提供Git仓库链接，确保仓库根目录有 composer.json 文件，然后点击 Check 和 Submit 按钮。
3. 安装包 ：运行以下命令安装包：

composer require foggyline/catalogbundle:dev-master

或者在现有项目的 composer.json 文件中添加相应条目：

{
"require": {
"foggyline/catalogbundle": "dev-master"
    },
}

总结

通过上述步骤，我们成功构建了一个简单的销售模块，并学会了如何使用Git和Composer进行模块的集成和分发。使用模块化开发可以使项目更易于维护和扩展，同时也方便与他人共享代码。虽然我们构建的应用还不够完善，但展示了如何使用PHP快速编写模块化应用的概念。在实际开发中，我们可以根据需求进一步完善和扩展这些模块。

流程图

graph LR
    classDef startend fill:#F5EBFF,stroke:#BE8FED,stroke-width:2px;
    classDef process fill:#E5F6FF,stroke:#73A6FF,stroke-width:2px;
    classDef decision fill:#FFF6CC,stroke:#FFBC52,stroke-width:2px;

    A([开始]):::startend --> B(构建销售模块):::process
    B --> C(单元测试):::process
    C --> D(功能测试):::process
    D --> E(使用Git拆分模块):::process
    E --> F(创建核心仓库):::process
    F --> G(创建模块仓库):::process
    G --> H(添加子模块):::process
    H --> I(提交.gitmodules文件):::process
    I --> J(克隆项目):::process
    J --> K(使用Composer管理依赖):::process
    K --> L(创建composer.json文件):::process
    L --> M(安装依赖项):::process
    M --> N(使用Packagist分发模块):::process
    N --> O(创建composer.json文件):::process
    O --> P(提交到Packagist):::process
    P --> Q(安装包):::process
    Q --> R([结束]):::startend

表格

工具/服务	作用	使用步骤
Git	版本控制，使用 submodules 拆分项目	1. 创建核心仓库；2. 创建模块仓库；3. 添加子模块；4. 提交 .gitmodules 文件；5. 克隆项目
Composer	依赖管理，定义项目依赖项	1. 创建 composer.json 文件；2. 运行 composer install 命令
Packagist	Composer包的主要仓库，用于分发模块	1. 创建 composer.json 文件；2. 提交到Packagist；3. 安装包

构建与分发模块化电商应用（续）

模块分发与依赖管理的深入探讨

在前面的内容中，我们已经了解了如何使用 Git 和 Composer 对模块进行集成和分发。接下来，我们将进一步探讨其中的一些关键要点。

模块依赖关系的处理

在开发销售模块时，我们发现它依赖于其他几个模块，如目录（Catalog）和客户（Customer）模块。在使用 Composer 进行依赖管理时，我们可以通过 composer.json 文件的 require 属性来明确这些依赖关系。

例如，在销售模块的 composer.json 文件中，可以这样定义依赖：

{
    "require": {
        "foggyline/catalogbundle": "dev-master",
        "foggyline/customerbundle": "dev-master"
    }
}

这样，当我们使用 Composer 安装销售模块时，它会自动下载并安装所需的目录和客户模块。

版本控制与更新

使用 Composer 进行模块分发的一个重要优势是可以进行版本控制。在前面的例子中，我们使用了 dev-master 来指定模块的版本，这意味着我们使用的是主分支的最新代码。在实际开发中，我们可能需要指定具体的版本号，以确保项目的稳定性。

例如，我们可以将 composer.json 文件中的依赖项指定为具体的版本号：

{
    "require": {
        "foggyline/catalogbundle": "1.0.1",
        "foggyline/customerbundle": "2.0.0"
    }
}

当模块有更新时，我们可以通过修改 composer.json 文件中的版本号，并运行 composer update 命令来更新项目中的模块。

模块化开发的优势与应用场景

模块化开发在电商应用开发中有许多优势，下面我们来详细分析一下。

易于维护和扩展

将应用程序拆分为多个模块后，每个模块的功能相对独立，这使得代码的维护和扩展变得更加容易。例如，如果我们需要对目录模块进行功能增强，只需要修改该模块的代码，而不会影响到其他模块。

提高开发效率

模块化开发允许不同的开发人员同时负责不同的模块，从而提高开发效率。例如，一个开发团队可以同时开发目录模块、客户模块和销售模块，最后将这些模块集成到一起。

便于代码共享

模块化的代码可以更容易地被其他项目复用。例如，如果我们开发了一个强大的目录模块，其他开发人员可以通过 Composer 直接引入该模块，而不需要重新编写代码。

实际应用案例分析

为了更好地理解模块化开发的应用，我们来看一个实际的案例。假设我们正在开发一个大型的电商平台，需要实现商品管理、客户管理、订单管理等功能。

模块化设计

我们可以将平台拆分为以下几个模块：
- 核心模块 ：包含应用程序的基础配置和公共功能。
- 目录模块 ：负责商品的管理，包括商品的添加、编辑、删除等操作。
- 客户模块 ：处理客户的注册、登录、信息管理等功能。
- 销售模块 ：实现购物车、订单处理、结账等功能。
- 支付模块 ：集成各种支付方式，如支付宝、微信支付等。
- 物流模块 ：处理商品的发货、物流跟踪等功能。

模块集成与开发

通过使用 Git 和 Composer，我们可以将这些模块分别开发和管理。每个模块都有自己的代码仓库，开发人员可以独立地进行开发和测试。在集成时，我们只需要在核心模块的 composer.json 文件中添加各个模块的依赖项，然后使用 Composer 进行安装。

总结与展望

通过本文的介绍，我们了解了如何构建一个简单的销售模块，并使用 Git 和 Composer 进行模块的集成和分发。模块化开发在电商应用开发中具有重要的意义，它可以提高开发效率、便于代码维护和扩展，同时也方便了代码的共享。

虽然我们构建的电商应用还比较简单，但所展示的模块化开发概念可以应用到更复杂的项目中。在未来的开发中，我们可以进一步完善这些模块，添加更多的功能，如多语言支持、多货币支持等，以满足不同用户的需求。

流程图

graph LR
    classDef startend fill:#F5EBFF,stroke:#BE8FED,stroke-width:2px;
    classDef process fill:#E5F6FF,stroke:#73A6FF,stroke-width:2px;
    classDef decision fill:#FFF6CC,stroke:#FFBC52,stroke-width:2px;

    A([开始开发电商平台]):::startend --> B(模块化设计):::process
    B --> C(核心模块开发):::process
    B --> D(目录模块开发):::process
    B --> E(客户模块开发):::process
    B --> F(销售模块开发):::process
    B --> G(支付模块开发):::process
    B --> H(物流模块开发):::process
    C --> I(模块集成):::process
    D --> I
    E --> I
    F --> I
    G --> I
    H --> I
    I --> J(测试与调试):::process
    J --> K(上线部署):::process
    K --> L([结束]):::startend

表格

模块名称	功能描述	依赖模块
核心模块	基础配置和公共功能	无
目录模块	商品管理	核心模块
客户模块	客户信息管理	核心模块
销售模块	购物车和订单处理	核心模块、目录模块、客户模块
支付模块	支付集成	核心模块、销售模块
物流模块	物流跟踪	核心模块、销售模块