Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Boas práticas com PHP: novidades, clean code e ...

Junior Grossi
September 26, 2019

Boas práticas com PHP: novidades, clean code e um pouco de arquitetura

O PHP tem mudado muito nos últimos anos. Neste workshop vamos passar brevemente pelas principais mudanças dos últimos 10 anos e discutir algumas boas práticas para tornar seu código mais limpo e aumentar sua produtividade, além de navegar um pouco no que tem de mais atual em se tratando de arquitetura de software.

Junior Grossi

September 26, 2019
Tweet

More Decks by Junior Grossi

Other Decks in Programming

Transcript

  1. PARTE 1 PHP ANTES E DEPOIS Os últimos 10 anos

    da linguagem mais usada na Web!
  2. PHP EM 2019 Linguagem mais usada na Web (~80%) Só

    o WordPress é responsável por ~36% Muito problema pra resolver (mais empregos)
  3. PHP 5.3 (2009) O DIVISOR DE ÁGUAS NAMESPACES + LAMBDA

    FUNCTIONS/CLOSURES (Mudanças no processo interno de releases do PHP)
  4. NAMESPACES Classes não podiam ter o mesmo nome HtmlPrinter, Zend_HtmlPrinter

    class Zend_HtmlPrinter { public function print(); }
  5. namespace Grossi\Talks; use Foo\Exporter\Exporter; use Zend\Html\Exporter as ZendExporter; class PhpTalk

    { public function export() { $fooExporter = new Exporter(); $zendExporter = new ZendExporter(); // ... } } https://wiki.php.net/rfc/namespacecurlies
  6. LAMBDA FUNCTIONS/CLOSURES Antes do PHP 5.3 A partir do PHP

    5.3 $array = array_map('append_x', $array); function append_x($item) { return $item . 'x'; } $array = array_map(function ($item) { return $item . 'x'; }, $array);
  7. Nova geração de frameworks (surgimento dos primeiros micro-frameworks) (execução tardia)

    $router­>get('/users/{id}', function ($id) { return User::find($id); }); $function = function ($word) { echo $word . ' World!'; } $function('Hello'); // "Hello World!"
  8. TRAITS trait Flyable { public function fly() { // Go,

    fly! } } trait Walkable { public function walk() { // Go, walk! } } class Bird { use Flyable, Walkable; } class Chicken { use Walkable; } $bird = new Bird(); $chicken = new Chicken(); $bird­>walk(); $bird­>fly(); $chicken­>walk();
  9. SHORTENED ARRAY SYNTAX Antes do PHP 5.4 Depois do PHP

    5.4 $numbers = array(1, 2, 3); $associative = array('name' => 'Junior', 'age' => 34); $numbers = [1, 2, 3]; $associative = ['name' => 'Junior', 'age' => 34];
  10. BUILT-IN WEB SERVER Não é necessário mais um Web server

    pra desenvolvimento > php ­S localhost:8000
  11. COMPOSER Resolveu o problema dos require > composer require cakephp/database

    require 'database.php'; require 'pdf.php'; require 'mail.php'; require 'image.php'; require 'sms.php'; $database = db_query('SELECT * FROM users');
  12. /composer.json { "name": "jgrossi/corcel", "description": "Use WordPress backend with Laravel

    or any PHP framework", "homepage": "http://github.com/corcel/corcel", "authors": [ { "name": "Junior Grossi", "email": "[email protected]" } ], "require": { "php": ">=7.1.3", "illuminate/database": "5.7.*", "hautelook/phpass": "0.3.*", "thunderer/shortcode": "^0.6.2" }, "require­dev": { "phpunit/phpunit": "^7.0", "mockery/mockery": "^1.0" }, "autoload": { "psr­4": { "Corcel\\": "src/", "Corcel\\Tests\\": "tests/" } } }
  13. PSR-7 PSR-11 namespace MyFramework\Http; use Psr\Http\Message\RequestInterface; class Request implements RequestInterface

    { } namespace MyFramework\Container; use Psr\Container\ContainerInterface; class Container implements ContainerInterface { }
  14. PHP 5.5 E 5.6 ANTES DA GRANDE MUDANÇA (2013 e

    2014) Adiciona scalar class name resolution via ::class Adiciona finally para exceptions Melhoria de performance (Zend OPcache) Outras mudanças...
  15. PHP 7 (2015) Nova Zend Engine (v3) 2x mais rápido

    que PHP 5 50% menos de consumo de memória
  16. PHP 7.0 UNIFORM VARIABLE SYNTAX // Before $foo = new

    Foo(); $baz = $foo­>bar(); // After $baz = (new Foo())­>bar(); // Before $foo = $foo­>bar(); echo $foo[0]; // After echo $foo­>bar()[0];
  17. PHP 7.0 NULL COALESCE OPERATOR: ?? // Before $age =

    isset($data['age']) ? $data['age'] : 100; // After $age = $data['age'] ?? 100;
  18. PHP 7.0 ⭐ RETURN TYPE DECLARATIONS ⭐ ⭐ SCALAR TYPE

    DECLARATIONS ⭐ (opcional) // Before public function create($sum, $title) { // your code here } // After public function create(float $sum, string $title): float { // your code here }
  19. STRICT TYPES = 1 declare(strict_types=1); namespace Foo\Printer; class CsvPrinter implements

    PrinterInterface { public function __construct(string $foo, float $bar) { // ... } }
  20. PHP 7.0 GROUP USE DECLARATIONS // Before use Package\Http\Request; use

    Package\Http\Response; use Package\Http\Middleware; use Package\Http\BaseController as Controller; // After use Package\Http\{ Request, Response, BaseController as Controller };
  21. PHP 7.1, 7.2 E 7.3 void return type class constant

    visibility modifiers nullable types the object parameter and return type Libsodium extension abstract method overriding
  22. class User { private const TYPE_ADMIN = 'admin'; protected const

    TYPE_MEMBER = 'member'; public const TYPE_GUEST = 'guest'; } public function save(object $object, ?int $age): void { // do something and return nothing }
  23. NOVIDADES: PHP 7.4 NOV/2019 Preloading* Short closures Typed properties Improved

    type variance The null coalescing assignment operator muito mais!
  24. PHP 7.4 SHORT CLOSURES array_map(function (User $user) use ($prefix) {

    return $prefix . $user­>id; }, $users) array_map(fn(User $user) => $prefix . $user­>id, $users)
  25. PHP 7.4 TYPED PROPERTIES ANTES class Foo { /** @var

    int $bar */ private $bar; /** @var callable $bar */ private $function; /** @var string|null $bar */ protected $baz; /** @var array $bar */ public $list; }
  26. PHP 7.4 TYPED PROPERTIES DEPOIS class Foo { private int

    $bar = 4; private callable $function; protected ?string $baz = null; public array $list = [1, 2, 3]; }
  27. CONSIDERAÇÕES FINAIS PHP é uma das linguagens mais maduras Excelente

    performance (e vai melhorar!) Desenvolvimento muito rápido!
  28. LIVRO Clean Code A Handbook of Agile So ware Cra

    smanship Robert C. Martin (Uncle Bob)
  29. AGENDA Resumo dos principais tópicos Não dá pra cobrir tudo

    Focado em PHP quando possível! Alguns detalhes vão ser explicados mais à frente
  30. CAPÍTULO 1 Clean Code "You are reading this book for

    two reasons. First, you are a programmer. Second, you want to be a better programmer. Good. We need better programmers."
  31. "CODE-SENSE" "A programmer without "code-sense" can look at a messy

    module and recognize the mess but will have no idea what to do about it. A programmer with "code-sense" will look at a messy module and see options and variations." Uncle Bob
  32. ALGUNS PONTOS Passamos mais tempo lendo código Escrever código limpo

    requer disciplina O "code-sense" é a chave! Alguns de nós nascem com o "code-sense" Outros só com a prática!
  33. CAPÍTULO 2 Meaningful Names "Names are everywhere in so ware.

    We name our variables, our functions, our arguments, classes, and packages. We name our source files and the directories that contain them. We name and name and name."
  34. class DtaRcrd102 { private DateTime $genymdhsm; private DateTime $modymdhms; private

    string $pszqint = "102"; } class Customer { private DateTime $generationTimestamp; private DateTime $modificarionTimestamp; private string $recordId = "102"; }
  35. NOMES "BUSCÁVEIS" / CONSTANTES for ($i = 0; $i <

    5; $i++) { // ... } for ($i = 0; $i < WORK_DAYS_PER_WEEK; $i++) { // ... }
  36. INTERFACES E IMPLEMENTAÇÕES Evitar informação demais pro usuário (dev) (estou

    passando uma interface ou classe concreta?) PSR Naming Conventions | Symfony UserInterface, AbstractResolver, ReusableTrait
  37. EVITE O "MAPA MENTAL" Não obrigue o usuário a tentar

    entender o que está escrito Buscar entender pelo contexto é muito mais demorado!
  38. NOMES DE CLASSES "Classes and objects should have noun or

    noun phrase names like Customer, WikiPage, Account, and AddressParser. Avoid words like Manager, Processor, Data, or Info in the name of a class. A class name should not be a verb." (resumindo: nome de classe = substantivo)
  39. NOMES DE MÉTODOS Devem ser verbos Devem ser declarativos (ações)

    Accessors (get), Mutators (set) e predicates (is)
  40. USE NOMES PRESENTES EM PADRÕES Todo dev sabe (ou deveria)

    saber Design Patterns Facilita o entendimento sobre a solução implementada AccountVisitor, ConsoleDecorator, UserFactory
  41. NÃO ADICIONE CONTEXTO DESNECESSÁRIO Contexto deve ficar no namespace Nome

    de classe deve resumir o que ela faz GSDAMailingAddress, GSDAAccountAddress GSDA\MailingAddress, GSDA\AccountAddress
  42. CAPÍTULO 3 Functions "In the early days of programming we

    composed our systems of routines and subroutines. Nowadays only the functions survives from those early days. Functions are the first line of organization in a any program."
  43. BLOCOS E INDENTAÇÃO Cada bloco de uma linha (chamada de

    método) Métodos com 1 ou 2 níveis de indentação foreach ($users as $user) { foreach ($user­>phoneNumbers() as $phoneNumber) { $this­>sendSmsToNumber($phoneNumber); } }
  44. FAÇA UMA COISA Devem fazer apenas uma coisa (e fazer

    bem) Nomes muito grande podem necessitar ser refatorados Palavras de alerta: And, Or, If
  45. "STEPDOWN RULE" Leitura fluente como texto if (!$user = $this­>findUser())

    { // ... } $this­>save($user); $user = $this­>findUser(); if (!$user) { // ... } $this­>save($user);
  46. private function something(): bool { return !$this­>foo() || $this­>bar(); }

    private function something(): bool { if (!$this­>foo()) { return false; } if ($this­>bar()) { return true; } return false; }
  47. switch Tolerados se aparecerem apenas uma vez Pensar em AbstractFactory

    se mais de uma vez Cuidado para não ferir SRP
  48. USE NOMES DESCRITIVOS Word's principle: "You know you are working

    on clean code when each routine turns out to be pretty much what you expected." Não tenha medo de escrever nomes longos Escreva exatamente o que está sendo feito
  49. ARGUMENTOS Nenhum é sempre melhor 1 ou 2 aceitáveis /

    3 deve ser evitado (aumento do número de argumentos dificulta escrever testes)
  50. "Flag Arguments" nunca (boolean) Deixa claro que faz mais de

    uma coisa Refatore para um método para cada coisa (argumento boolean exige mais de um caso de teste, sempre!)
  51. Encapsule argumentos em objetos (dá mais significado ao argumento) private

    function makeCircle(float $x, float $y): Circle { // ... } private function makeCircle(Point $point): Circle { // ... }
  52. Verbos e palavras-chave (dá mais significado ao argumento) public function

    find(Email $email): User { // ... } public function findUserByEmail(Email $email): User { // ... }
  53. "Truth can only be found in one place: the code.

    Only the code can truly tell you what it does."
  54. /** * Returns the day of the month. * *

    @return int the day of the month. */ public function getDayOfMonth(): int { return $this­>dayOfMonth; }
  55. /** The first name */ private string $firstName; /** The

    last name */ private string $lastName; /* Added by Junior */ $response = new InputStreamResponse(); $response­>setBody($formatter­>getResultStream()); // $resultStream = $formatter­>getResultStream(); // $reader = new StreamReader($resultStram);
  56. Escolhe um code style e o siga Agrupe blocos de

    linhas no mesmo contexto Declare variáveis próximo da utilização Variáveis de instância sempre no topo da classe $user = $this­>findUserByEmail($email); $event = new Event($user); $email = new WelcomeEmail(); $email­>to($user­>email()); $email­>send();
  57. Funções dependentes próximas Não alinhe horizontalmente class FitNesseExpediter implements ResponseSender

    { private Socket $socket; private InputStream $input; private OutputStream $output; private Request $request; private Response $response; private FitNesseContext $context; private float $requestParsingTimeLimit; protected float $requestProgress; }
  58. CAPÍTULO 6 Objetos e Estrutura de Dados "There is a

    reason that we keep our variables private. We don't want anyone else to depende on them. We want to keep the freedom to change their type or implementation on a whim or an impulse."
  59. Esconder implementação expões abstrações Manipular a essência dos dados por

    abstrações OOP permite adicionar novas classes sem mudar as existentes class HtmlParser implements ParserInterface { public function parse(): string { } }
  60. LEI DE DEMETER "Fale com amigos, não com estranhos." Encapsule

    o máximo possível. Exponha apenas o necessário.
  61. CAPÍTULO 7 Error Handling "...things can go wrong, and when

    they do, we as programmers are responsible for making sure that our code does what it needs to do."
  62. Exceptions sempre. Código de erro nunca! Escreva o bloco try/catch

    primeiro (facilita pensar em todas as possíveis exceções)
  63. Exceptions como primeira opção Trate a exceção na origem public

    function resolveUser(): User { $user = $this­>findInRequest(); if (!$user) { throw new UserNotFoundException(); } return $user; } try { $user = $resolver­>resolveUser(); } catch (UserNotFoundException $e) { return null; }
  64. DEFINA CONTEXTO public static function byEmail(string $email): self { return

    new self( sprintf('User not found with the email %s', $email) ); } throw UserNotFoundException::byEmail($user­>getEmail());
  65. CAPÍTULO 9 Unit Tests "The Agile and TDD movements have

    encouraged many programmers to write automated unit tests, and more are joining their ranks every day. But in the mad rush to add testing to our discipline, many programmers have missed one of the more subtle, and important, points of writing good tests."
  66. AS 3 LEIS DO TDD 1. Escreva um teste que

    irá falhar. 2. Escreva o código para fazê-lo passar. 3. Repita o processo.
  67. CLEAN TESTS? Clean Code também para testes Crie "helpers" em

    forma de trait para adicionar funcionalidades extras trait JwtAuthenticationTrait { use HttpRequestsTrait; public function loginUser(User $user): void { $serializedToken = $this­>generateTokenForUser($user); $this­>request­>withHeader( 'HTTP_AUTHORIZATION', sprintf('Bearer %s', $serializedToken) ); } }
  68. Teste com usuário admin + teste com não admin public

    function test_only_admins_can_change_user_type(): void {} public function test_admin_users_can_change_user_type(): void {} public function test_non_admin_users_cannot_change_user_type(): void
  69. "FIRST" RULE Fast: testes devem ser rápidos (evite DB pra

    testes - utilize mais in-memory objects) Independent: não devem compartilhar detalhes (um teste não pode influenciar resultado de outro) Repeatable: independentes de ambiente Self-Validating: ou passou ou não passou (boolean) Timely: escreva testes sempre antes (depois + difícil de testar)
  70. BÔNUS! Regra dos 3As (Arrange, Act, Assert) public function test_admin_users_can_change_user_type():

    void { // Arrange $admin = $this­>makeAdminUser(); $user = $this­>makeNormalUser(['type' => User::TYPE_MEMBER]); $this­>loginAsUser($admin); // Act $formatter = new Formatter(); $user = $formatter­>format($user); // Assert $this­>assertEquals(User::TYPE_MEMBER, $user­>getType()); }
  71. ENCAPSULAMENTO private por padrão protected quando necessário (herança ou testes)

    Foco sempre em encapsular primeiro! (use abstrações)
  72. CLASSES PEQUENAS Evite "God Classes" (SRP) Tamanho é determinado pelo

    nome! (evite Manager ou Processor) Caso feliz: ter um único método público (SRP) (facilita muito abstração)
  73. Nada de TokenManager ou coisas do tipo! OCP - Open-close

    Principle final class JwtTokenGenerator implements TokenGeneratorInterface {} final class IntegrationTokenGenerator implements TokenGeneratorInterface { private TokenGeneratorInterface $tokenGenerator; public function __construct(TokenGeneratorInterface $tokenGenerator) { $this­>tokenGenerator = $tokenGenerator; } }
  74. CONCLUSÕES Qualidade é um execício diário Comece a praticar (experiência)

    Melhoria de processos Diminuição de complexidade
  75. Robert C. Martin "O objetivo da arquitetura de so ware

    é minimizar os recursos humanos necessários para construir e manter um sistema."
  76. DESENVOLVIMENTO So ware difícil de manter tem vida curta Arquitetura

    facilita desenvolvimento para o time que o mantém
  77. Uma boa arquitetura começa com bons acordos Decisões em conjunto

    (time!) Comunicação é fundamental Mudar arquitetura é muito caro!
  78. MATURIDADE Às vezes grandes projetos começam pequenos Zero (ou pouca)

    arquitetura Problemas de arquitetura aparecem bem depois
  79. OBJETIVOS Fácil desenvolvimento / baixo custo Publicação rápida e fácil

    Diminuir custos com manutenção (custo mais caro)
  80. "Arquitetura fala por si só" Sobre o que é seu

    so ware? Olhando código! Leilão? Loja virtual? Reserva de hotéis? Ou uma aplicação Laravel? Zend? Symfony?
  81. "Uma boa arquitetura de so ware permite que decisões sobre

    frameworks, banco de dados, servidores web, e outros detalhes de ferramentas de ambiente, fiquem pra depois." Uncle Bob "Frameworks são opções a serem deixadas em aberto."
  82. QUAL O FOCO? (facilitar conversa com camada de negócios) "Uma

    boa arquitetura enfatiza os casos de uso e os dissocia de preocupações periférias."
  83. Não! Web é o mecanismo de entrega Sua arquitetura não

    deve se preocupar com entrega A Web é apenas um detalhe
  84. PARA TESTAR: Você não precisa de framework Você não precisa

    de servidor web Você não precisa de banco de dados
  85. Lembrete: seus casos de uso são desacoplados! Seus casos de

    uso coordenam suas classes Entity. "Seus objetos Entity devem ser objetos simples que não possuem dependência nenhuma com frameworks ou bancos de dados."
  86. CARACTERÍSTICAS COMUNS Independente de frameworks (framework-as-a-tool) Testável sem qualquer elemento

    externo Independente da UI (Web / Console) Independente de banco de dados Independente de qualquer agente externo
  87. THE DEPENDENCY RULE "Dependências de código devem apontar somente para

    dentro, na direção de políticas de nível mais alto." Nada em um círculo interno pode saber alguma coisa concreta sobre algo em um círculo externo.
  88. THE DEPENDENCY RULE (AS 4 CAMADAS) 1. Entities (Enterprise Business

    Rules) 2. Use Cases (Application Business Rules) 3. Interface Adapters 4. Frameworks and Drivers
  89. 2. USE CASES Regras de Negócio específicas da aplicação Comandam

    o fluxo de dados ("de" e "para" as entidades) Mudanças nesta camada não devem afetar as entidades. (Command/Handler pattern)
  90. 3. INTERFACE ADAPTERS Conversão de dados externos para camadas internas

    ("Use Cases" e "Entities" - e vice-versa) MVC (Model, View, Controller) Ex: códigos SQL Nenhum código de camadas mais internas deve saber algo de banco de dados, por exemplo.
  91. 4. FRAMEWORKS AND DRIVERS Geralmente não se escreve código nesta

    camada Camada onde vão todos os detalhes ("Web é um detalhe", "banco de dados é um detalhe") Do lado de fora estes detalhes não podem fazer muito estrago. Uncle Bob "Não case com o framework!"
  92. ATRAVESSANDO LIMITES Exemplo do que não se deve fazer Consulta

    ao ORM retorna um row object, não a representação do seu domínio. Você não pode passar esse row object para dentro do círculo, pois as camadas internas não devem saber nada sobre objetos das camadas de fora (BD). Doctrine ORM vs Eloquent ORM (Laravel)
  93. Command é um objeto simples imutável, que contem todos os

    inputs necessários para executar o "Handler" Handler é a execução do comando, com suas próprias dependências. Ele sabe que precisa do Command para processar.
  94. final class CreateUserAction { private CreateUserHandler $handler; public function __construct(CreateUserHandler

    $handler) { $this­>handler = $handler; } public function __invoke(RequestInterface $request): ResponseInterface { $user = $this­>handler­>handle( new CreateUserCommand( $request­>getAttribute('email'), $request­>getAttribute('firstName'), $request­>getAttribute('lastName'), $request­>getAttribute('password'), ) ); return new JsonResponse($user, 201); } }
  95. 2. COMMAND Classe simples que guarda os dados necessários para

    execução da ação. Classe imutável!
  96. final class CreateUserCommand implements CommandInterface { private string $email; private

    string $firstName; private string $lastName; private string $password; public function __construct( string $email, string $firstName, string $lastName, string $password ) { $this­>email = $email; $this­>firstName = $firstName; $this­>lastName = $lastName; $this­>password = $password; } // Getters: getEmail(), getFirstName(), getLastName(), getPassword() }
  97. final class CreateUserHandler implements HandlerInterface { private UserRepositoryInterface $userRepository; private

    PasswordEncrypterInterface $passwordEncrypter; public function __construct( UserRepositoryInterface $userRepository, PasswordEncrypterInterface $passwordEncrypter ) { $this­>userRepository = $userRepository; $this­>passwordEncrypter = $passwordEncrypter; } public function handle(CreateUserCommand $command): UserEntity { return $this­>userRepository­>create([ 'email' => $command­>getEmail(), 'firstName' => $command­>getFirstName(), 'lastName' => $command­>getLastName(), 'password' => $this­>passwordEncrypter­>encrypt($command­>getPassw ]); } }
  98. PRÓXIMO PASSO Adicionar um CommandBus (responsável por executar os Handlers)

    composer require league/tactician composer require illuminate/bus