Repository files navigation

• Introdução
• 1. Diagrama de Classe
• 2. Diagrama E-R - Modelo de banco de dados
• 3. Tecnologias Utilizadas
• 4. Interface do sistema
  • 4.1 Login
    • 4.1.1 Erro ao logar
  • 4.2 Tela Inicial
  • 4.3 Menu Lateral
    • 4.3.1 Dashboard
    • 4.3.2 Vendas
      • 4.3.2.1 Cadastro de venda
      • 4.3.2.2 Pesquisa de vendas
    • 4.3.3 Estoque
      • 4.3.3.1 Estilo
        • 4.3.3.1.1 Edição de estilo
        • 4.3.3.1.2 Exclusão de estilo
        • 4.3.3.1.3 Cadastro de estilo
      • 4.3.3.2 Cervejas
        • 4.3.3.2.1 Edição de cerveja
        • 4.3.3.2.2 Exclusão de cerveja
        • 4.3.3.2.3 Cadastro de cerveja
    • 4.3.4 Cadastro
      • 4.3.4.1 Cidades
        • 4.3.4.1.1 Edição de cidade
        • 4.3.4.1.2 Exclusão de cidade
        • 4.3.4.1.3 Cadastro de cidade
      • 4.3.4.2 Clientes
        • 4.3.4.2.1 Edição de cliente
        • 4.3.4.2.2 Exclusão de cliente
        • 4.3.4.2.3 Cadastro de cidade
      • 4.3.4.3 Usuários
        • 4.3.4.3.1 Edição de usuário
        • 4.3.4.3.2 Exclusão de usuário
        • 4.3.4.3.3 Cadastro de usuário
    • 4.3.5 Relatórios
      • 4.3.5.1 Vendas emitidas
  • 4.4 Telas de informações
    • 4.4.1 Acesso negado
    • 4.4.2 Página não encontrada
    • 4.4.3 Página de erro no servidor
    • 4.4.4 Página de sessão expirada
  • 4.5 Responsividade
  • 4.6 Internacionalização
• 5 Segurança
  • 5.1 Autenticação
    • 5.1.1 BCrypt
  • 5.2 Autorização
  • 5.3 Cross-Site Request Forgery (CSRF)
  • 5.4 Expiração de múltiplos login
  • 5.5 Duração de sessão
  • 5.6 SQL Injection
  • 5.7 Validação de formulário

    Brewer é um sistema online de vendas de cervejas responsivo para se adaptar a todos tipos de telas que tem como papel agilizar o processo de vendas de cerveja ou propondo ao cliente registrar um orçamento ou recebê-lo por e-mail para uma compra futura.

    Este artigo descreve como o sistema foi projetado utilizando diagrama de classes para exibição da arquitetura do projeto e a modelagem de banco de dados para exibir os relacionamentos entre as tabelas do banco de dados, tecnologias utilizadas também como as funcionalidades do sistema e práticas de seguranças utilizadas.

    Afigura 1 descreve a estrutura do sistema Brewer modelando suas classes descrevendo seus atributos e as relações entre objetos.

Figura 1 - Diagrama de classe

    Afigura 2 representa graficamente as entidades e seus relacionamentos com as de mais entidades do banco de dados

Figura 2 - ER - Diagrama entidade relacionamento

    A seguir serão listadas todas as tecnologias utilizadas no desenvolvimento do sistema Brewer

• Java - Linguagem de programação utilizada para o desenvolvimento do sistema.

• Spring Framework - Frameworks responsável pela arquitetura MVC e seguranças comBCrypt no projeto.

• Thymeleaf - Template engine do projeto responsável por transmitir dados para tela, construção de layout das telas.

• JPA/Hibernate - Utilizada a especificação doJPA para persistência dos dados utilizando a implementação doHibernate.

• HTML 5 e CSS3 - Usada para codificação e estilização do projeto utilizando também a biblioteca CSS doBootstrap.

• Javascript e jQuery - Usada para interatividade com o usuário e controles dos dados do sistema.

• Maven - Para arquitetura inicial de projeto e controle de dependências.

• Flyway Para a utilização de banco de dados incremental.

• MySql - Linguagem de banco de dados utilizada.

• SLF4 e Log4j - Para controle dos log da aplicação.

• Bean Validation e Hibernate Validator - Usado validação de entidades e validações de campos.

• Thumbnailator - Para criação de thumbmail das imagens da cervejas.

• JUnit - Para teste unitários.

• Java Mail - Responsável pelos envio de e-mail utilizando serviço dosendgrid.

• ChartJS - Para geração de gráficos.

• JasperReport - Para geração de relatórios do sistema.

    Nesse tópico serão mostradas as principais telas do sistemas seguindo de suas funcionalidades.

    Inicialmente o sistema inicia na tela de “login” onde o vendedor irá entrar com seus dados de autenticação, como mostrado nafigura 3.

Figura 3 - Tela de login

    Na figura 4 é mostrado a mensagem de falha ao tentar logar caso o vendedor informe seus dados incorretamente.

Figura 4 - Mensagem de falha ao tentar logar

    A tela inicial do sistema é composta por um cabeçalho contendo a logo do sistema Brewer, nome do vendedor e o botão de sair (logout) mais abaixo temos o menu lateral com os menus do sistema (ver próximo tópico) e a área de conteúdo que exibe a página de “Dashboard” do sistema e por fim o rodapé no final da página contendo o nome do desenvolvedor do sistema.Figura 5.

Figura 5 - Dashboard - Tela inicial do sistema

    No menu lateral temos 5 menus e seus submenus.

• Dashboard
• Vendas
  • Cadastro de venda
  • Pesquisa de vendas
• Estoque
  • Estilo
  • Cervejas
• Cadastro
  • Cidades
  • Clientes
  • Usuários
• Relatórios
  • Vendas emitidas

    A tela de “Dashboard” serão feitas o levantamento de algumas informações como “Valor do estoque”, “Itens no estoque”, “Total de clientes”, “Vendas no ano”, “Vendas no mês”, “Ticket médio” assim como dois gráficos, um mostrando a quantidades de vendas nos últimos 6 meses e o outro a quantidade de cervejas “Nacional” e “Internacional” vendidas. Como mostrado nafigura 5.

    O menu de vendas possui dois submenus “Cadastro de venda” e “Pesquisa de vendas”.

    No cadastro de venda encontra-se 3 caixas de informações “Total”, “Status” e “Criação” representando o valor total da compra, o status da compra se está em “Orçamento”, “Emitida” ou “Cancelada”. e a data de criação da compra. Abaixo temos o formulário da venda com os campos de pesquisa rápida de “Cliente”, entrada de “Valor do frete”, entrada de “Valor do desconto” e duas abas terminando o formulário. Mostrado nafigura 6.

Figura 6 - Tela de cadastro de venda

    Na aba “Cervejas” temos um campo de pesquisa rápida de cerveja onde ao digitar o “Nome” ou “SKU” aparecerá uma caixa de seleção contendo o nome, SKU, origem e o valor unitário da cerveja. Após selecionar a cerveja ela aparecerá na tabela de itens da venda logo abaixo do campo de pesquisa rápida de “Cliente”.Figura 7.

Figura 7 - Tela de cadastro de venda preenchida

    Na Aba de entrega encontra-se outro formulário com os campos “Data de entrega”, “Horário de entrega” e “Observação” exibida nafigura 8.

Figura 8 - Tela de cadastro de venda (Guia entrada)

    Após preencher os campos obrigatórios da venda é possível “Salvar” esta venda com o “Status” de “Orçamento” ou “Salvar e emitir” para salvar e emitir uma venda e mudar seu “Status” para “Emitida” ou “Salvar e enviar por e-mail” para salvar a venda com “Status” de “Orçamentos” e enviando um e-mail para o cliente com seus dados desta venda, confira afigura 9 o recebimento do e-mail com os dados da venda

Figura 9 - Tela do e-mail recebido

    Na tela de pesquisa de vendas nafigura 10 podem ser filtradas as vendas pelos seguintes filtros “Código”, “Status”, “Data de criação”, “Valor Total”, “Nome Cliente”, “CPF/JNPG” e a baixo a listagem de vendas filtradas.Pesquisando por quaisquer dos campos retornará a busca clicando no botão “Pesquisar”. Ao deixar os campos de filtros vazios será retornado todas as vendas.

Figura 10 - Tela de pesquisa de vendas

    Observação: todas as paginações do sistema são feitas no servidor, ou seja, são trafegadas somente uma determinada quantidade de registros do servidor fazendo-a assim trafegar menos dados do servidor deixando aplicação mais rápida e dinâmica.

    Na listagem de venda nafigura 10 cada “venda” possui um ícone de edição onde pode-se fazer alteração da venda ou o cancelamento da venda.

    Na tela de “Edição de venda exibida" nafigura 11, sómente osadministradores e odono da venda tem permissão para cancelar uma venda.

Figura 11 - Tela de edição de venda

    Caso o vendedor sem administrador tente cancelar uma venda em que ele não registrou, o mesmo será redirecionado para uma página de acesso negado. Figura 12.

Figura 12 - Tela acesso negado

    O menu de estoque possui dois submenus “Estilos” e “Cervejas”.

    No submenu “Estilos” figura 13, encontra-se a página de pesquisa de estilos com o campo de pesquisa de estilo e a tabela de registro de estilos tendo acima o botão “Novo estilo”.

    Na listagem de estilo nafigura 13 cada registro possui os íconea de edição e exclusão.

Figura 13 - Tela de pesquisa de estilos

    Na edição de estilofigura 14, encontra-se o campo de estilo preenchido com o dados do registro selecionado e o botão “Salvar” para alterar o “estilo”.

Figura 14 - Tela de edição de estilo

    No ícone de exclusão de estilo abrirá uma caixa de diálogo com a confirmação se deseja excluir este estilofigura 15.

Figura 15 - Tela de exclusão de estilo

    No cadastro de estilosfigura 16, encontra-se a página de cadastro de estilo com o campo de estilo e o botão “Salvar” para salvar um novo “estilo”.

Figura 16 - Tela de cadastro de estilo

    No submenu “Cervejas” figura 17 , encontra-se a página de pesquisa de cervejas com os campos de pesquisa por “SKU”, “Nome”, “Estilo”, “Sabor”, “Origem”,“Valor unitário” e a tabela de registro de cervejas tendo acima o botão “Nova Cerveja”.

Figura 17 - Tela de pesquisa de cervejas

    Na edição de cervejafigura 18, encontra-se os campos preenchido com o dados do registro selecionado e o botão “Salvar” para alterar a “cerveja”.

Figura 18 - Tela de edição de estilo

    No ícone de exclusão de cerveja abrirá uma caixa de diálogo com a confirmação se deseja excluir esta cervejafigura 19.

Figura 19 - Tela de exclusão de cerveja

    No cadastro de cervejasfigura 20, encontra-se a página de cadastro de cervejas com o formulário de preenchimento de cerveja e o botão “Salvar” para salvar uma nova “cerveja”.

Figura 20 - Tela de cadastro de cerveja

    Caso tenha cadastrado uma cerveja sem foto ao salvar a cerveja será usada uma foto padrão para as cervejas sem foto.Figura 21.

Figura 21 - Imagem para cervejas sem foto

    É possível cadastrar um novo “estilo” clicando no ícone de (+) ao lado do campo “Estilo”. assim fazendo-o abrir uma caixa de diálogofigura 22 para cadastrar um novo “estilo”. Após o cadastramento de um novo estilo o mesmo já vem selecionado na caixa de seleção de “Estilo”.

Figura 22 - Caixa de diálogo de cadastro estilo rapido

    O menu de cadastro possui três submenus “Cidades”, “Cliente” e “Usuário”.

    No submenu “Cidades” figura 23, encontra-se a página de pesquisa de cidades com os campos de pesquisa de cidades e a tabela de registro de cidades tendo acima o botão “Nova cidade”.

    Na listagem de cidade nafigura 23 cada registro possui um ícone de edição e outros de exclusão.

Figura 23 - Tela de pesquisa de cidades

    Na edição de cidadefigura 24, encontra-se os campos preenchido com o dados do registro selecionado e o botão “Salvar” para alterar a “cidade”.

Figura 24 - Tela de edição de cidade

    No ícone de exclusão de cidade abrirá uma caixa de diálogo com a confirmação se deseja excluir esta cidadefigura 25.

Figura 25 - Tela de exclusão de cidade

    No cadastro de cidadesfigura 26, encontra-se a página de cadastro de cidade com os campos do formulário de cidade e o botão “Salvar” para salvar uma nova “cidade”.

Figura 26 - Tela de cadastro de cidade

    No submenu “Clientes” figura 27, encontra-se a página de pesquisa de clientes com os campos de pesquisa de clientes e a tabela de registro de clientes tendo acima o botão “Novo cliente”.

    Na listagem de cliente nafigura 27 cada registro possui um ícone de edição e outros de exclusão.

Figura 27 - Tela de pesquisa de clientes

    Na edição de cidadefigura 28, encontra-se os campos preenchido com o dados do registro selecionado e o botão “Salvar” para alterar o “cliente”.

Figura 28 - Tela de edição de cliente

    No ícone de exclusão de cliente abrirá uma caixa de diálogo com a confirmação se deseja excluir esta cidadefigura 29.

Figura 29 - Tela de exclusão de cliente

    No cadastro de cidadesfigura 30, encontra-se a página de cadastro de cidade com os campos do formulário de cidade e o botão “Salvar” para salvar uma nova “cidade”.

Figura 30 - Tela de cadastro de cliente

    No submenu “Usuários” figura 31, encontra-se a página de pesquisa de usuários com os campos de pesquisa de usuários e a tabela de registro de usuários tendo acima o botão “Novo Usuário”.

    Na listagem de usuário nafigura 31 cada registro possui um ícone de edição e outros de exclusão.

    Observação: nas caixas de seleções não é possível selecionar o caixa de seleção do usuário logado para evitar erros comuns de desativamento do usuário logado.

Figura 31 - Tela de pesquisa de usuários

    Na edição de usuáriofigura 32, encontra-se os campos preenchido com o dados do registro selecionado e o botão “Salvar” para alterar o “usuário”.

Figura 32 - Tela de edição de usuário

    No ícone de exclusão de usuário abrirá uma caixa de diálogo com a confirmação se deseja excluir este usuáriofigura 33.

Figura 33 - Tela de exclusão de usuário

    No cadastro de usuáriofigura 34, encontra-se a página de cadastro de usuário com os campos do formulário de usuários e o botão “Salvar” para salvar um novo “usuário”.

Figura 34 - Tela de cadastro de usuário

    O menu de relatório possui apenas um submenus “Vendas emitidas”.

    No submenu “Vendas emitidas” figura 35, encontra-se a página de relatório de vendas emitidas com dois campos de datas para preencher os intervalos entre essas duas datas e o botão de “Emitir”.

Figura 35 - Tela de relatório de vendas emitidas

    Ao emitir o relatório de vendas emitidas o relatório irá abrir automaticamente,figura 36, exibindo os registros do filtro informado.

Figura 36 - Relatório emitido

    É comum do usuário eventualmente acabar fazendo alguma ação inesperada, para esse tipos de situações o usuário será redirecionado para a tela contendo a informação da sua ação inesperada.

    Ao tentar acessar uma URL de alguma função restrita do sistema, o sistema irá redirecionar para a página de acesso negado.Figura 37.

Figura 37 - Tela de acesso negado

    Ao tentar acessar uma URL não existente, o sistema irá redirecionar para a página de página não encontrada.Figura 38.

Figura 38 - Tela de página não encontrada

    Caso ocorra algo inesperado com o sistema, o sistema irá redirecionar para a página de erro no servidor.Figura 39.

Figura 39 - Tela de erro no servidor

    Caso o mesmo usuário tente logar novamente ao sistema já tendo uma sessão ativa, o sistema irá redirecionar para a página de sessão expirada.Figura 40.

Figura 40 - Tela de sessão expirada

    O sistema brewer possui responsividade para se adaptar a telas de diversos aparelhos. Nafigura 41 temos a tela de um dispositivo móvel de tela pequena.

Figura 41 - Tela de Dashboard responsiva

    O sistema brewer possui internacionalização adaptada para duas línguas, sendo ela portugues e ingles. Nafigura 42 temos a tela do Dashboard do sistema toda na linguagem inglesa só trocando o idioma do navegador utilizado.

Figura 41 - Tela de Dashboard em inglês

    O sistema brewer possui alguma camadas de seguranças a qual permite uma veracidade e integridade dentro do sistema.

    Com a autenticação cada “usuário” do sistema possui seu “e-mail” e “senha” para efetuar seu login.

    Observação: É preciso estar autenticado para operar qualquer funcionalidade dentro do sistema.

    Ao cadastrar um usuário no sistema a senha desse usuário utiliza a criptografia “BCrypt” para transformar a senha desse usuário num “hash” de 60 caracteres.

    O sistema brewer trabalha com níveis de permissão onde o usuário comum só pode ter acesso a funções do sistema relacionado ao vendedor, enquanto os usuários com permissões de administradores podem ter acesso a todo o sistema.

    “CSRF” é uma ferramenta de segurança que valida uma requisição. O que impede o sequestro de uma requisição entre sites, ou seja, quando algum usuário logado no sistema executa algum codigo malicioso recebido por alguém mal intencionado para executar alguma ação dentro do sistema se aproveitando da requisição do usuário logado.

    Expiração de múltiplos login ocorre quando o usuário já está logado no sistema e acaba se logando novamente de outro lugar, fazendo-o assim a sessão antiga se perder (deslogar) e se mantendo ativo somente com a última sessão logada.

    O sistema brewer trabalha com o tempo de sessão de inoperatividade de 20 minutos, ou seja, se o usuário ficar 20 minutos sem fazer qualquer atividade dentro do sistema ele perderá sua sessão e terá que fazer o login novamente.

    SQL Injection é uma técnica onde um atacante cria ou altera comandos SQL existentes para expor dados escondidos, ou sobrescrever dados valiosos, ou ainda executar comandos de sistema perigosos no servidor.

    O sistema brewer é implementado com o implementação do hibernate e com especificação JPA, essas ferramentas evitam falhas de seguranças como SQL Injection.

    O sistema brewer utiliza da APIBean Validation eHibernate Validator para auxiliar nas validações de formulários utilizando suas anotações e criando anotações de validações de campos próprias.