Skip to main content

Dicas

Claro!

Modelagem:

Aqui
    estão
  • Nomes Consistentes: Use nomes consistentes e descritivos para as dicastabelas ajustadase, consequentemente, para as classes de negócio. Utilize as convenções de nomenclatura verificadas no e-Campus.
  • Relacionamentos: Defina claramente os relacionamentos entre as tabelas usando chaves estrangeiras. Lembrando que, quanto mais relacionamentos houver, maior a chance de aumentar a complexidade da implementação frameworklógica.
    • Miolo:

###

Classes Modelde negócio (Modelo)
1.Business):

**
  1. Responsabilidade Única**única: Cada modelo no Miolo deve ser responsável apenas pela lógica de dados do aplicativo.dados. Evite misturar a lógica de negócios com a lógica de apresentação.
    2.
    2. **Validações**: Centralize as validaç
  2. Associações dos dados no modelo usando os métodos disponíveis no Miolo. Isso garante que os dados sejam validados antes de serem processados.
    3. **Associações**    : Defina corretamente as associações entre os modelosmodelos, (por exemplo, `hasOne`, `hasMany`). Isso facilita as consultas e a manipulaçãoafim de dadosevitar relacionados.
    4.dificuldades **Scopes**:nas Utilizepesquisas.
    3. scopes
para

Formulários:

criar
    consultas reutilizáveis no Miolo. Isso ajuda a manter o código limpo e organizado.
    5. **Migrations**: Use migrations para gerenciar as mudanças no esquema do banco de dados. Documente cada migração para facilitar o entendimento das alterações.

    ### View (Visão)
    1. **

  1. Separação de Lógica**gica: Mantenha a lógica de apresentação separada da lógica de negócios. UtilizeTente helpersutilizar eos partialsformulários paraapenas organizarvisando apenas a apresentação códigodas norespostas Miolo.
    2.aos **Simplicidade**usuários.
  2. Simplicidade: Mantenha asos views no Mioloformulários o mais simples quanto possível. EviteFormulários colocar muita lógica nas views; isso deve ser feito nos controllers ou helpers.
    3. **Layoutssimples e Partials**funcionais são indicativos de interfaces mais bem utilizáveis.

Handlers:

  1. Responsabilidade Única: UseConsidere layoutsutilizar paraum definirhandler apor estruturacontexto geralde do site e partials para componentes reutilizáveis no Miolo.aplicação. Isso facilitafacilitará a manutenção edas afuncionalidades.
    2. reutilização
  2. Checagem de código.
    4.acessos:     **CSSUtilize eas JStransações Separados**:apropriadamente, Separepara que se tenha o CSScontrole ede o JavaScript do código HTML. Utilize arquivos externos para estilização e scripts, mantendo as viewsacesso mais limpasseguro equanto organizadas.
    5.possível.
    3. **Internacionalização (i18n)**: Utilize os mecanismos de internacionalização do Miolo para facilitar a tradução do conteúdo das views.

    ### Controller (Controlador)
    1. **Responsabilidade Única**: Cada ação do controlador no Miolo deve ter uma única responsabilidade. Se uma ação estiver fazendo muitas coisas, considere refatorar.
    2. **Filtros**: Utilize filtros (por exemplo, `beforeFilter`) para realizar ações comuns, como autenticação de usuário, antes de executar a lógica principal.
    3. **Tratamento de Exceções**: Implemente o tratamento adequado de exceções para garantir que o aplicativo lide graciosamente com erros.
    4. **RESTful**: Adote convenções RESTful ao definir as rotas e ações dos controladores no Miolo. Isso torna a API mais previsível e fácil de usar.
    5. **Serviços e Interatores**: Considere mover a lógica complexa para objetos de serviço ou interatores. Isso ajuda a manter os controladores pequenos e focados.

    ### Gerais
    1. **Código Limpo**: Siga princípios de código limpo, como a nomenclatura clara de variáveis e métodos, comentários explicativos quando necessário e refatoração regular do código.
    2. **Testes**: Escreva testes para seus modelos, controladores e views no Miolo. Use frameworks de teste para garantir que seu código funcione conforme o esperado.
    3. **Documentação**: Documente o código e as decisões arquiteturais. Isso facilita a manutenção e a colaboração com outros desenvolvedores.
    4. **Reutilização de Código**: Identifique padrões e oportunidades para reutilizar código. Use herança, mixins ou módulos para compartilhar funcionalidades comuns no Miolo.
    5. **Segurança**: Esteja atento a práticas de segurança, como proteção contra injeção de SQL, XSS e CSRF. Valide e sanitize todas as entradas do usuário.

    Essas dicas específicas para o Miolo ajudarão a manter o código organizado, sustentável e fácil de manter.

Back to top