Treinamento de boas práticas de programação OutSystems

Roberto Almeida (roberto.almeida@outsystems.com.br)
Arianna Olivera (arianna.salmon@outsystems.com.br

Transcript

1. Treinamento de Boas práticas de Programação Roberto Almeida (roberto.almeida@outsystems.com.br) Arianna Olivera (arianna.salmon@outsystems.com.br)
2. 2 • Etapa 1 (18/04) - Apresentação - Boas práticas Arquiteturais • Etapa 2 - Boas práticas na área de Dados - Boas práticas Lógicas • Etapa 3 - Boas práticas na Interface - Ferramentas Auxiliares Programação do treinamento
3. 3 O que são boas práticas?
4. 4 Manutenção e Fácil Entendimento Por que usar?
5. 5 Por que a True Change tem que usar boas práticas?
6. 6 O que são AOs? Application Objects (AOs)
7. 7 Unidade de medição de uma aplicação Application Objects (AOs)
8. 8 O que consome AOs? Consumo de AOs
9. 9 O que consome AOs? Consumo de AOs - Entities • Entities • Static Entities • Local Entities • External Tables (Via Integration Studio)
10. 10 O que consome AOs? Consumo de AOs - Integrations • Consume REST/SOAP • Expose REST/SOAP • Consume SAP
11. 11 O que consome AOs? Consumo de AOs - Screens • Web Screens • E-mail Screens • Mobile Screens • SMS Screens
12. 12 Não Consome AOs • Site Properties • Session Variables • Timers • Process • Roles • Themes • Local Variables • Web Blocks • Structures • Referências a Entities • Consumo de API através do Integration Studio • Consumo de Actions de outros módulos
13. Boas práticas Arquiteturais
14. 14 Our target when building a Solution Architecture • Aligned with Business strategy • Promotes reusability • Maintainable • Scalable • Performant Divisão arquitetural 4 layer Canvas
15. 15 • Usability • Functionality • Efficiency • Maintainability • Portability • Reliability Building quality solutions
16. 16 Why is architecture important?
17. 17 Why modular programming? Why is architecture important? • Abstraction: hide implementation • Isolation: easier to test and to maintain • Manage Complexity: tackle smaller problems • Efficient Teamwork: working on different modules at the same time
18. 18 Modules • Data: Entities, Structures; • Logic: Actions, Roles; • UI: Screens, Images, Web Blocks, Themes; • Processes. Why is architecture important? Extension Modules • Integration with external systems • Developed in Integration Studio
19. 19 What is the 4 Layer Canvas? Extensions, connectors, goodies, UI patterns Services around business concepts, exporting reusable entities, Business interfaces, processes and logic Mash-up of end user modules
20. 20 • No upward references • No side references among orchestration or end-user modules • No cyclic references Validating the Architecture No end-user screens No business logic or core entities No role-based logic
21. 21 Apply the 3 validation rules to application modules Applying the 4 Layer Canvas to applications
22. 22 Apply the same rules between applications Applying the 4 Layer Canvas to applications
23. 23 Solving the issues Applying the 4 Layer Canvas to applications
24. 24 Don’t mix change pace Applying the 4 Layer Canvas to applications
25. 25 Don’t mix owners Applying the 4 Layer Canvas to applications
26. 26 Don’t mix sponsors Applying the 4 Layer Canvas to applications
27. 27 Core application consumes and produces modules to another application Some violation examples...
28. 28 Orchestration application with several consumers Some violation examples...
29. 29 Side violations Some violation examples...
30. 30 Sempre que possível seguir o padrão 4 layer canvas. • Organização • Desacoplamento • Facilidade no entendimento • Padrão aconselhado pela OutSystems Padrão 4 layer Canvas
31. 31 Separação e nomenclatura do Core
32. 32 Defina Responsabilidades claras para cada módulo
33. 33 Separe os módulos para facilitar a Publicação e o Deploy
34. 34 Concentre informações gerais para facilitar o reuso
35. 35 Olhar para o futuro do projeto para definir o modelo arquitetural
36. Treinamento de Boas práticas de Programação Roberto Almeida Arianna Olivera
37. 37 • Etapa 1 (18/04) - Apresentação - Boas práticas Arquiteturais • Etapa 2 (25/04) - Boas práticas na área de Dados - Boas práticas Lógicas • Etapa 3 - Boas práticas na Interface - Ferramentas Auxiliares Programação do treinamento
38. Duvidas Anteriores
39. 39 Formato da Licença Duvidas Anteriores Application Object + +
40. 40 Duvidas Anteriores Application Object 400 AOs + 400 AOs + 400 AOs ... 3 Servidores + 1 Servidor ... 100 Usuários + 100 Usuários ...
41. Boas práticas na área de Dados
42. 42 Tamanho das Entities
43. 43 Tamanho das Entities Preferencialmente entidades com até 20 atributos
44. 44 Isolar entidades com Binary Data
45. 45 Arquivar Dados Antigos
46. 46 Quarteto fantástico das entidades
47. 47 Quarteto fantástico das entidades
48. 48 Wrapper do CRUD de Entidades
49. 49 Wrapper do CRUD de Entidades
50. 50 Wrapper do CRUD de Entidades
51. 51 Wrapper do CRUD de Entidades
52. 52 • Consulta permanece durante a navegação • Informações temporárias relevantes • Problema de performance • Acesso global da informação Perigos e vantagens das Session Variables
53. 53 1. Um índice é uma estrutura associada a uma tabela que acelera a recuperação de linhas de uma tabela ou exibição. 2. Ao definir entidades em Outsystems, é possível especificar índices, além daqueles criados automaticamente. Index
54. 54 Índices automáticos • OutSystems cria automaticamente um índice, para cada chave estrangeira. • Índices automáticos são excluídos se a regra de DELETE for alterada para Ignorar. Index Índices personalizados • É possível definir seus próprios índices, e melhorar o desempenho das aplicações.
55. 55 1. Criar índices compostos para campos que são muito usados em conjunto nas queries 2. Se um grupo de atributos for sempre utilizado em conjunto para fazer uma query 3. Índices em tabelas de lookup são importantes Por que usar Index?
56. 56 Usar o sufixo “Id”
57. 57 • Protect • Delete • Ignore Cheque se as regras de delete das chaves estrangeiras estão corretas
58. 58 Aggregate ou SQL? Deem preferência no uso de Aggregates X
59. 59 Não coloque lógica de negócio dentro do SQL +
60. Boas práticas Lógicas
61. 61 • Não deve conter regras de negócios • Deve ter menos de 10 nós • Baixa complexidade • Fácil entendimento Preparation tem que ser bem simples
62. 62 Mantenha o fluxo das Actions vertical, unidirecional, alinhado e compacto Vertical Unidirecional Alinhado Compacto
63. 63 Mantenha o fluxo das Actions vertical, unidirecional, alinhado e compacto
64. 64 Mantenha o fluxo das Actions vertical, unidirecional, alinhado e compacto
65. 65 Mantenha o fluxo das Actions vertical, unidirecional, alinhado e compacto
66. 66 Mantenha o fluxo das Actions vertical, unidirecional, alinhado e compacto
67. 67 • Diminui a complexidade • Facilita o entendimento • Possibilita o reuso • Melhora a manutenção Encapsule lógicas em Actions separadas
68. 68 Ficar de olho nos reports do Service Center
69. 69 Encapsule lógicas em Actions separadas
70. 70 Encapsule lógicas em Actions separadas
71. 71 Encapsule lógicas em Actions separadas
72. 72 Ficar de olho nos reports do Service Center
73. 73 • Numero de requisições ao banco pode ser exponencial • Problema grave de performance • Em muitos casos pode ser resolvido com um JOIN Cuidado com Aggregates dentro de For Each
74. 74 • Deve ter obrigatoriamente apena 1 Parâmetro de saída. • Pode ter Múltiplos Parâmetros de Entrada • Pode ser usada em qualquer Expression Encapsule dados no formato de Funções
75. 75 Comente logicas complexas ou exóticas
76. 76 Pascal Case é a prática de escrever palavras compostas ou frases de modo que cada palavra ou abreviatura comece com uma letra maiúscula. Ex: “FedEx”, “HarperCollins”, “PropertyDescriptor” e “HtmlTag” Usar PascalCase
77. 77 Todas as Actions que forem usadas por um Timer deve ser acompanhada do prefixo “Timer_” para facilitar a identificação. Usar o prefixo “Timer_” quando a Action for usada por um Timer
78. 78 Entendendo Roles e Groups
79. 79 • O consumo de CADA método REST/SOAP consome 1 AO • A exposição de CADA método REST/SOAP consome 1 AO • Muita atenção ao expor e consumir REST/SOAP dentro da mesma aplicação Cuidados com o consumo de AOs nas Integrações
80. Treinamento de Boas práticas de Programação Roberto Almeida Arianna Olivera