Developing for Business

Globalcode – Open4education
Developing for Business
Trilha – PHP Architecture

apresentação
Antonio Spinelli
@tonicospinelli
tonicospinelli85@gmail.com

o propósito sempre é o mesmo:
resolver problema para o negócio!

comportamento
problema simples
vs
soluções complexas

comportamento
escopo abstrato
=
problema desconhecido

comportamento
agregue valor para negócio
entenda a demanda
agilidade não é "sobrinhagem"

conhecimento
leia código
peça e faça code review
automatize tarefas repetitivas

user story
Lista de Desejos
Eu como usuário convidado, quero adicionar um produto
esgotado em minha lista de desejos para que eu receba uma
notificação quando este estiver disponível.
Objetivo
reposição mais inteligente de produtos

php estruturado

php estruturado
adicionando um item
na lista de desejos

// public/wishlist.php
// ...
if (isset($_POST['submit']) && isValidWishList($_POST['wish_item'])) {
$wishItem = getWishList($_POST['wish_item']);
$db->beginTransaction();
try {
$stm = $db->prepare(
'INSERT INTO wishlists (email, product_id) VALUES (?, ?)'
);
$stm->execute([$wishItem['email'], $wishItem['product_id']]);
$db->commit();
$successmsg = 'Product was added at wish list successfully!';
} catch (Exception $e) {
$db->rollBack();
$errormsg = 'Product could not be added at wishlist! :(';
}
}
// ...
php estruturado

php estruturado
// ...
<table>
<?php foreach ($wishlist as $wish): ?>
<tr>
<td><?php echo $wish['id']; ?> </td>
<td><?php echo $wish['product_name']; ?> </td>
<?php if ($wish['product_stock'] == 0): ?>
<td>Not Available</td>
<?php else: ?>
<td>Available</td>
<?php endif; ?>
<td>
<?php echo removeUrl($wish['id'], ['email' => $email]); ?>
</td>
</tr>
<?php endforeach; ?>
</table>
// ...

php estruturado
notificar usuário que
o item está disponível

php estruturado
// cli/wishlist_notify.php
// ...
$query = "find all available products from wishlist";
$stm = $db->prepare($query);
$stm->execute();
$wishlists = $stm->fetchAll(PDO::FETCH_ASSOC);
foreach ($wishlists as $wishlist) {
mail(
$wishlist['email'],
"{$wishlist['product_name']} disponível",
$mailBody
);
$stm = $db->prepare("UPDATE wishlists SET status='S' WHERE id=?");
$stm->execute([$wishlist['id']]);
}

php estruturado
Pronto! funciona!

php estruturado
quais problemas neste código?

php estruturado
organização pobre
sem verificação de erro
dificuldade de reusar código

php estruturado
isolando a apresentação

php estruturado
// templates/wishlist/list.php
<table>
<tr>
<td><?php echo $wish['id']; ?> </td>
<td><?php echo $wish['product_name']; ?> </td>
<?php if ($wish['product_stock'] == 0): ?>
<td>Not Available</td>
<?php else: ?>
<td>Available</td>
<?php endif; ?>
<td>
<?php echo removeUrl($wish['id'], ['email' => $email]); ?>
</td>
</tr>
</table>

php estruturado
isolando regras de negócio

php estruturado
function isValidWishList(array $data);
function getWishList(array $data);
function findAllWishProducts($email);
function addWishItem(array $data);
function removeWishItem($id);
function findAllWishlistsToNotify();
function wishlistNotified($id);

php estruturado
interagindo com
regra de negócio e apresentação

php estruturado
public/wishlist.php
require_once __DIR__ . '/../lib/functions.php';
require_once __DIR__ . '/../lib/models/wishlist.php';
require_once __DIR__ . '/../lib/dbconn.php';
if (addWishItem($wishItem)) {
} else {
}
}
$wishlist = findAllWishProducts($_GET['email']);
include __DIR__ . '/../templates/wishlists/list.php';

php estruturado
isolando layout

php estruturado
// template/layout.php
<!DOCTYPE html>
<html>
<head>
<title><?php echo $title ?></title>
</head>
<body>
<?php echo $content ?>
</body>
</html>

php estruturado
// template/wishlist/list.php
<?php $title = 'My Wish List' ?>
<?php ob_start() ?>
<table>
<tbody>
<tr></tr>
</tbody>
</table>
<?php $content = ob_get_clean() ?>
<?php include __DIR__ . '/../layout.php' ?>

php estruturado
front controller

php estruturado
Without a front controller
GET /wishlist.php?email=email@test.com
With index.php as the front controller
GET /index.php/wishlist/email@test.com

php puro front controller
// public/index.php
// load function files
// route the request internally
$uri = parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH);
$method = $_SERVER['REQUEST_METHOD'];
if (preg_match('/wishlist/(.*)$', $uri, $matches) && $method == 'GET') {
wishlistListAction($matches[1]);
} elseif ('/index.php/wishlist/add' === $uri && $method == 'POST') {
wishlistAddAction($_GET['email'], $_POST);
} else {
header('HTTP/1.1 404 Not Found');
echo '<html><body><h1>Page Not Found</h1></body></html>';
}

php estruturado
autoload

php estruturado autoload
// public/index.php
require_once __DIR__ . '/../config/app.php';
require_once LIBRARY_DIR . '/functions.php';
require_once LIBRARY_DIR . '/models/wishlist.php';
require_once LIBRARY_DIR . '/controllers/wishlist.php';
// include_path is other alternative
ini_set('include_path', __DIR__ . '/../lib');

php estruturado composer
{
"name": "tonicospinelli/developing-for-business",
"description": "A Quick Project for Talk",
"license": "MIT",
"autoload": {
"files": [
"./lib/dbconn.php",
"./lib/functions.php",
"./lib/controllers/wishlist.php",
"./lib/models/wishlist.php"
]
}
}

php estruturado projeto
developing-for-business
├── cli
│ └── wishlist_notification.php
├── composer.json
├── config
│ └── app.php
├── lib
│ ├── controllers
│ │ └── wishlist.php
│ ├── functions.php
│ └── models
│ └── wishlist.php
├── public
│ └── index.php
└── templates
└── wishlists

php business

php business
clareza no código
facilidade de crescimento
testes automatizados

php business

php business testes automatizados
garantem regras conhecidas
auxiliam refatoração
não evitam bugs

php business phpunit
PHPUnit 5.4.6 by Sebastian Bergmann and contributors.
................................................... 59 / 59 (100%)
Time: 349 ms, Memory: 6.00MB
OK (59 tests, 126 assertions)

PHPUnit 5.4.6 by Sebastian Bergmann and contributors.
..................................F................ 59 / 59 (100%)
Time: 374 ms, Memory: 6.00MB
There was 1 failure:
1) ProductTest::testUpdateProductFailed
Failed asserting that exception of type "ProductException" is
thrown.
FAILURES!
Tests: 59, Assertions: 125, Failures: 1.
php business phpunit

php business
não confie em arrays
evite abreviações

/**
* Creates a new wish list data.
* @param array $data
* @return array
*/
function newWishList(array $data)
{
return array(
'email' => isset($data['email']) ? $data['email'] : null),
'product_id' => $data['product_id'],
'status' => 'P',
);
}
php business array, não confie!

php business
objetos de valor

php business objetos de valor
são objetos simples
encapsulam tipos primitivos
representam o valor

class Status
{
const PENDING = 'P';
const SENT = 'S';
public function __construct($status)
{
$this->validate($status);
$this->status = $status;
}
// … other methods
public function equalsTo(Status $status)
{
return $status === $this;
}
}
php business objetos de valor

php business
entidades

php business entidades
são mutáveis
possuem identificador

class Wishlist
{
public function __construct(
Id $id,
Email email,
WishlistItem $item,
Status $status
) {
$this->id = $id;
$this->email = $email;
$this->item = $item;
$this->status = $status;
}
}

class WishlistItem
{
public function __construct(
Id $id,
$name,
Available $isAvailable
) {
$this->id = $id;
$this->name = $name;
$this->available = $isAvailable;
}
}

php business
repositórios

php business repositórios
camada de persistência
estratégia de armazenamento

interface WishlistRepository
{
public function find($id);
public function findAllByEmail($email);
public function add(Wishlist $wishlist);
public function delete(Wishlist $wishlist);
public function findAllToNotify();
}

namespace DevelopBusinessApplicationProductWishlistRepositories;
class PdoRepository implements WishlistRepository
{
public function __construct(PDO $driver, Factory $factory);
public function findAllByEmail($email)
{
$query = "find all items by email";
$stm = $this->driver->prepare($query);
$stm->execute([$email]);
return $stm->fetchAll(
PDO::FETCH_FUNC,
[$this->factory, 'create']
);
}
}

namespace DevelopBusinessApplicationProductWishlistRepositories;
class RedisRepository implements WishlistRepository
{
public function __construct(Predis $driver, Factory $factory);
public function find($id)
{
$wishlist = $this->driver->get($this->getKey($id));
if (!$wishlist) {
throw WishlistNotFoundException::byIdentifier($id);
}
return $this->factory->fromJson($wishlist);
}
}

class PdoRepositoryTest extends PHPUnit_Framework_TestCase
{
public function testAddNewRowSuccessful()
{
$wishlist = $this->factory->fromQueryResult(/* args */);
$pdoSpy = new PDOSpy();
(new Repository($pdoSpy))->add($wishlist);
$this->assertTrue($pdoSpy->beginTransactionCalled);
$this->assertTrue($pdoSpy->commitCalled);
$this->assertEquals(2, $wishlist->getId());
}
}

class PDOSpy extends PDO
{
public function beginTransaction()
{
$this->beginTransactionCalled = true;
}
public function prepare($statement, $options = null)
{
if ($statement == INSERT INTO wishlists VALUES (?, ?, ?)') {
return new WriteStatementStub($this->failureOnWrite);
}
throw new InvalidArgumentException(
"None Stub Statement was found for query: {$statement}"
);
}
}

function wishlistListAction($email)
{
$db = dbConnect();
$factory = new WishlistFactory();
$repository = new WishlistPdoRepository($db, $factory);
$wishlist = $repository->findAllByEmail($email);
include TEMPLATE_DIR . '/wishlists/list.php';
}

php business
serviços

php business serviços
camada de operações
orquestram os objetos
definem o que fazer

$db = dbConnect();
$repository = new WishlistRepository($db, $factory);
$resolver = new ItemResolver(new ProductRepository($db));
try {
$intention = getIntention($request['wish_item']);
$useCase = new AddItemWishlistUseCase(
$repository, $factory, $resolver
);
$wishlist = $useCase->execute($intention);
$successmsg = "{$wishlist->getItemName()} added!";
$errormsg = $e->getMessage();
}

class AddItemWishlistUseCase
{
public function execute(AddItemIntention $intention)
{
$item = $this->resolver->resolve($intention->itemId);
try {
$this->repository->findOneByEmailAndItem($email, $item);
throw WishlistException::itemAlreadyExists($wishlist);
} catch (WishlistNotFoundException $e) {
// do nothing
}
$wishlist = $this->factory->new($email, $item);
return $this->repository->add($wishlist);
}
}

// cli/wishlist_notify.php
require_once __DIR__ . '/../vendor/autoload.php';
$repository = new WishlistRepository(dbConnect(), $factory);
$notifier = new MailNotifier();
$intention = new NotifyProductsAvailableIntention($pending);
$useCase = new NotifyProductsAvailableUseCase($repository, $notifier);
$useCase->execute($intention);

class NotifyProductsAvailableUseCase
{
public function __construct($repository, $notifier)
public function execute(NotifyProductsIntention $intention)
{
$status = $intention->getStatus();
$wishlists = $this->repository->findAllByStatus($status);
foreach ($wishlists as $wishlist) {
$this->notifier()->send($wishlist);
$wishlist->changeStatusTo(Status::sent());
$this->repository->update($wishlist);
}
}
}

php business
injeção de dependências

php business injeção de dependência
princípio da inversão de dependência
dependências configuráveis

Respect/Config

// config/app.ini
[databaseConnection PDO]
__construct = ["sqlite:../data/business.db", null, null]
[factory WishlistFactory]
[repository WishlistRepository]
__construct = [[databaseConnection], [factory]]
[productRepository ProductRepository]
driver = [databaseConnection]
[itemResolver WishlistItemResolver]
product = [productRepository]

// public/index.php
require_once __DIR__ . '/../vendor/autoload.php';
$configFile = __DIR__ . '/../config/app.ini';
$container = new RespectConfigContainer($configFile);
if ('/index.php/wishlist/add' === $uri /* other validation */) {
wishlistAddAction($container, $_GET['email'], $_POST);
}

function wishlistAddAction(Container $container, $email, $request)
{
try {
$useCase = $container->wishlistAddItemWishlistUseCase;
}
}

php business
eventos

php business eventos
mecanismo de inversão de controle
comunicação assíncrona
baixo acoplamento

symfony/event-dispatcher

class UpdateProductUseCase
{
public function __construct($repository, $factory, $eventDispatcher);
public function execute(Intention $intention)
{
// do something
$this->repository->update($updatedProduct);
$event = new ProductWasUpdated($updatedProduct);
$this->dispatch('product.updated', $event);
if ($this->isStockIncreased($product, $updatedProduct)) {
$this->dispatch('product.stock.increased', $event);
}
return $updatedProduct;
}
}

class StockListener
{
public function __construct(NotifyProductAvailable $useCase);
public function __invoke(ProductStockIncreasedEvent $event)
{
$productId = $event->getProduct()->getId();
$intention = new NotifyProductIntention($productId);
$this->useCase->execute($intention);
}
}

config/app.ini
[wishlistStockListener StockHasIncreasedListener]
useCase = [notifyProductAvailableUseCase]
[eventDispatcher EventDispatcher]
addListener[] = ["product.stock.increased", [wishlistStockListener]]
[productUpdateUseCase UpdateProductUseCase]
__construct = [[repository], [factory], [eventDispatcher]]

php business
estrutura

camadas
business
use cases
application
web
devices
useinterface
database
ExternalInterfaces

// ...
$db->beginTransaction();
try {
$stm = $db->prepare(
'INSERT INTO wishlists (email, product_id) VALUES (?, ?)'
);
$stm->execute([$wishItem['email'], $wishItem['product_id']]);
$db->commit();
$db->rollBack();
}
}
php estruturado

function wishlistAddAction(Container $container, $email, $request)
{
try {
$useCase = $container->wishlistAddItemWishlistUseCase;
}
}
php business

estrutura inicial
├── cli
│ ├── create_tables.php
│ └── wishlist_notification.php
├── data
│ └── business.db
├── lib
│ ├── dbconn.php
│ └── functions.php
└── public
├── product.php
└── wishlist.phpw

estrutura de negócio
└── src
└── Application
├── Product
│ ├── Controllers
│ └── Repositories
└── ProductWishlist
├── Controllers
├── Listeners
└── Repositories
└── src
├── Product
│ ├── Events
│ ├── Exceptions
│ ├── Intentions
│ ├── Repositories
│ └── UseCases
└── Wishlist
├── Exceptions
├── Intentions
├── Repositories
└── UseCases

conclusão
saia da zona de conforto
domain driven design
domain specific language
princípio solid

Life's too short for bad software
Lew Cirne, New Relic

Implementing Domain-Driven Design
by Vaughn Vernon
Patterns of Enterprise Application Architecture
by Martin Fowler
Domain-Driven Design
by Eric Evans
DDD in PHP
by Carlos Buenosvinos, Christian Soronellas and Keyvan Akbary
referências

Obrigado
tonicospinelli/developing-for-business
https://joind.in/talk/ad6a7

Developing for Business

Recommended

Recommended

More Related Content

What's hot

What's hot (19)

Similar to Developing for Business

Similar to Developing for Business (20)

More from Antonio Spinelli

More from Antonio Spinelli (6)

Recently uploaded

Recently uploaded (20)

Developing for Business