Microsserviços - Envio de e-mails

Integrantes do grupo:

• Fernando Garamvolgyi Mafra Veizaga - 20203001902
• Gabriel Siqueira Silva - 20203008814

---

O que será necessário?

---

• O serviço de e-mail terá sua própria base dados, nesse roteiro iremos utilizar o PostgreSQL na versão 14;
• Linguagem Java, nesse roteiro será utilizada a versão 11;
• Maven Project, Spring Web, Spring Boot, na versão 2.7.4, e o Spring Mail;
• Spring initializer;
• IDE da sua escolha, nesse roteiro será utilizado o VSCode.

---

Parte 1 - Codificação inicial

---

---

Setup inicial e inicialização do banco de dados

---

A fim de separar todo o processo em várias etapas, propomos a construção de algumas pastas para separação de arquivos, são elas:

Na pasta resources há um arquivo chamado application.properties, que serve para estabelecer a conexão com o banco de dados. No entanto, inicialmente ele está vazio. Como estamos utilizando o PostgreSQL, o código abaixo, com a porta 5432, estabelecerá a conexão:

server.port = 8080

spring.datasource.url = jdbc:postgresql://localhost:5432/ms-email
spring.datasource.username = postgres
spring.datasource.password = postgres
spring.jpa.hibernate.ddl-auto = update

Lembrando que 5432 é a porta padrão, caso tenha alterado, utilize a porta escolhida. Já o ms-email é o nome do banco criado no PostgreSQL.

---

Configurando o model para recebimento de e-mails

---

Com o banco de dados inicializado, devemos estabelecer as partes do nosso microsserviço e suas responsabilidades. Começando pela pasta model, devemos criar um sistema de recebimento de armazenamento das informações do e-mail, destinatário e remetente, a data, o conteúdo e tudo que compõe o processo de comunicação. Dito isso, em model, cria-se:

package com.microservices.email.models;

import java.io.Serializable;
import java.time.LocalDateTime;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;

import com.microservices.email.enums.StatusEmail;

import lombok.Data;

@Data // Criação de construtores automatizada
@Entity // É uma entidade por compor uma banco de dados
@Table(name = "TB_EMAIL") // Nome da tabela
public class MEmail implements Serializable{
    private static final long serialVersionUID = 1L;

    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    // Geração de e-mails automatica
    private long emailId;
    private String ownerRef; // O proprietário da mensagem
    private String emailFrom; // De quem vem
    private String emailTo; // Para quem envia
    private String subject; // Assunto
    @Column(columnDefinition = "TEXT") // Retira a limitação de 256 caracteres
    private String text;
    private LocalDateTime sendDateEmail;
    private StatusEmail statusEmail;
}

Como o estado do e-mail não é uma classe própria do Java, devemos criá-la. Estabeleceremos que ela contém os possíveis estados de um e-mail, portanto, enviado ou não enviado (error). Passível de enumeração, vamos criar o arquivo StatusEmail.java na pasta enum com o seguinte código:

package com.microservices.email.enums;

public enum StatusEmail {

    SENT,
    ERROR;
}

---

Configurando o dtos

---

Utilizado para transportar dados entre diferentes componentes de um sistema, o dto é utilizado em sistemas distribuídos e sistemas via serialização. A ideia é otimizar a comunicação por meio de um agrupamento de atributos, nesse caso:

package com.microservices.email.dtos;

import javax.validation.constraints.Email;
import javax.validation.constraints.NotBlank;

import lombok.Data;

@Data
public class DEmail {
    
    @NotBlank // Impede que a informação na tabela seja vazia
    private String ownerRef;
    @NotBlank
    @Email // Verifica o formato de e-mail
    private String emailFrom;
    @NotBlank
    @Email
    private String emailTo;
    @NotBlank
    private String subject;
    @NotBlank
    private String text;
}

A validação @NotBlank define que o setor recebido por POST não pode estar vazio e, além disso, emailFrom e emailTo devem estar no formato de Email. Para tal, há essa validação de @Email.

---

Configurando interfaces (repositories), services e controllers

---

Anteriormente, foi definido a forma da disposição das tabelas que vão compor o sistema e, portanto, é necessário estipular algo que povoe o sistema. Para isso, utilizamos uma interface que extende o JpaRepository, administrador de dados, dos quais são formados pela entidade MEmail, já que esse é o modelo. Então, adicionamos nos repositories um arquivo com o seguinte código:

package com.microservices.email.repositories;

import java.util.UUID;  
  
import org.springframework.data.jpa.repository.JpaRepository;

import com.microservices.email.models.MEmail;

public interface REmail extends JpaRepository<MEmail, UUID>{

}

Com a interface criada, devemos gerar um serviço para que ocorra a manipulação e a efetiva inserção dos dados. Portanto, em serviços, criamos um novo arquivo com o seguinte detalhamento:

  package com.microservices.email.services;

  import org.springframework.beans.factory.annotation.Autowired;
  import org.springframework.stereotype.Service;

  import com.microservices.email.models.MEmail;
  import com.microservices.email.repositories.REmail;

  @Service
  public class SEmail {

      @Autowired // Ponto de inserção de dados
      REmail emailRepository;
  
      public void sendEmail(MEmail emailModel){
  
      }
  }

Com o objetivo de conectar as operações do serviço com as tabelas que deverão existir, se faz necessário o uso de um controlador. O controlador nesse caso cuidará do envio de e-mails, validando-os e os tranformando de DTO para modelo, prontificando-o, dessa forma, para a inserção.

package com.microservices.email.controller;

import javax.validation.Valid;

import org.springframework.beans.BeanUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

import com.microservices.email.dtos.DEmail;
import com.microservices.email.models.MEmail;
import com.microservices.email.services.SEmail;

@RestController
public class CEmail {
    
    @Autowired
    SEmail emailService;

    @PostMapping(value="/sending-email")
    public ResponseEntity<MEmail> sendingEmail(@RequestBody @Valid DEmail emailDTO) {
        MEmail emailModel = new MEmail();
        BeanUtils.copyProperties(emailDTO, emailModel);
        emailService.sendEmail(emailModel);
        return new ResponseEntity<>(emailModel, HttpStatus.CREATED);
    }
    
}

---

Parte 2 - A instauração do SMTP

---

A fins de demonstração, o envio de emails neste microsserviço será feito através da utilização do Simple Mail Transfer Protocol (SMTP) da Google. Para um serviço mais robusto e completo, pode-se utilizar o Amazon SS (Simple Email Service).

Para configurarmos o serviço em nossa aplicação, devemos adicionar e preencher campos específicos no arquivo application.properties. Ao adicionarmos os campos necessários utilizando o namespace spring.mail, o arquivo ficará com a seguinte configuração:

server.port=8080

spring.datasource.url= jdbc:postgresql://localhost:5432/ms-email
spring.datasource.username=postgres
spring.datasource.password=postgres
spring.jpa.hibernate.ddl-auto=update

spring.mail.host=smtp.gmail.com
spring.mail.port=587
spring.mail.username=gabrielsiqueira2765@gmail.com
spring.mail.password=xkjohmxifgvcgrou
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true

Os campos que restam a serem preenchidos, "username" e "password", devem ser completados da seguinte forma:

• Username: utiliza-se um endereço de email do próprio programador, que servirá como o remetente dos emails enviados;
• Password: esse campo deve ser preenchido com uma "senha de aplicativo", ou seja, um código de 16 dígitos gerado ao seguir o passo a passo presente no link https://support.google.com/accounts/answer/185833.

O método responsável pelo envio e salvamento dos emails na base de dados é chamado de sendEmail, localizado no arquivo SEmail da pasta services, que implementa um ponto de injeção com a interface JavaMailSender, do framework Spring Boot, possibilitando a aplicação dessa funcionalidade no projeto:

package com.microservices.