Olá! Seja bem vindo ;)
- SpringBootApp
- Projeto e Conteúdo
- Swagger
- JWT
- SQL Server e JDBC
- SMTP
- Testes unitários (jUnit e JaCoCo))
- Publicação
- Suporte
Este repositório contém um exemplo de APIs REST desenvolvida em JAVA utilizando o framework Spring Boot com SQL Server para armazenameto de dados
JDK 1.8 + Maven 3.0 +
- Faça o download do zip ou clone o repositório Git.
- Descompacte o arquivo zip (caso tenha baixado o .zip)
- Abra o diretório Prompt de Comando e Altere (cd) para a pasta que contém pom.xml
- Abra o visual code ou execute o comando via prompt
code . - Pressione
F5para executar a aplicação.
A aplicação deverá estar disponivel em seu navegador no endereço: http://localhost:8080/swagger-ui.html
- Java Extension Pack from Microsoft
- Spring Boot Extension Pack from Pivotal
- Spring Boot Dashboard from Microsoft
- Lombok Annotations Support for VS Code from Gabriel Basilio Brito
- Java Code Generators from Sohibe
- Pressione
Ctrl+Virgula. - Procure por "java.home".
Caso você esteja usando a versão mais recente do vscode: - Digite no seu java path(Não se esqueça de colocar no caminho em:
" ").*
Caso você esteja em uma versão mais antiga do vscode: - Clique no lápis ao lado da linha que começa com "java.home".
- Clique em "Copy to settings".
- Digite no seu java path(Não se esqueça de colocar no caminho em:
" ").* - Press
Ctrl+S
Se você não sabe o seu caminho java, digitewhich javano seu terminal (no Windows, observe o formato correto, e.g:"java.home": "C:/Program Files/Java/jdk-11.0.2")
O Spring Boot é um projeto da Spring que veio para facilitar o processo de configuração e publicação de nossas aplicações. A intenção é ter o seu projeto rodando o mais rápido possível e sem complicação. Ele consegue isso favorecendo a convenção sobre a configuração. Basta que você diga pra ele quais módulos deseja utilizar (WEB, Template, Persistência, Segurança, etc.) que ele vai reconhecer e configurar.
O Swagger é uma aplicação open source que auxilia os desenvolvedores a definir, criar, documentar e consumir APIs REST; É composto de um arquivo de configuração, que pode ser definido em YAML ou JSON; Fornece ferramentas para: auxiliar na definição do arquivo de configuração (Swagger Editor), interagir com API através das definições do arquivo de configuração (Swagger UI) e gerar templates de código a partir do arquivo de configuração (Swagger Codegen).
fonte: https://swagger.io/resources/webinars/getting-started-with-swagger/
A maneira mais fácil de instalar é usar o Maven:
pom.xml
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>Exemplo de implementação para testes
@EnableSwagger2
@RestController
@RequestMapping(value="/api")
public class MainController {
@GetMapping(value="/ola")
public String getMethodName(){
return "Olá mundo";
}O JWT (JSON Web Token) nada mais é que um padrão (RFC-7519) de mercado que define como transmitir e armazenar objetos JSON de forma simples, compacta e segura entre diferentes aplicações, muito utilizado para validar serviços em Web Services pois os dados contidos no token gerado pode ser validado a qualquer momento uma vez que ele é assinado digitalmente.
JSON Web Tokens (JWT) é um padrão stateless porque o servidor autorizador não precisa manter nenhum estado; o próprio token é sulficiente para verificar a autorização de um portador de token.
Os JWTs são assinados usando um algoritmo de assinatura digital (por exemplo, RSA) que não pode ser forjado. Por isso, qualquer pessoa que confie no certificado do assinante pode confiar com segurança que o JWT é autêntico. Não há necessidade de um servidor consultar o servidor emissor de token para confirmar sua autenticidade.
fonte: https://jwt.io/introduction/
pom.xml
<dependency>
<groupId>io.jsonwebtoken</groupId>
<artifactId>jjwt</artifactId>
<version>0.9.1</version>
</dependency>Encode
try {
Algorithm algorithm = Algorithm.HMAC256("secret");
String token = JWT.create()
.withIssuer("auth0")
.sign(algorithm);
} catch (JWTCreationException exception){
//Invalid Signing configuration / Couldn't convert Claims.
}Verify a Token
String token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXUyJ9.eyJpc3MiOiJhdXRoMCJ9.AbIJTDMFc7yUa5MhvcP03nJPyCPzZtQcGEp-zWfOkEE";
try {
Algorithm algorithm = Algorithm.HMAC256("secret");
JWTVerifier verifier = JWT.require(algorithm)
.withIssuer("auth0")
.build(); //Reusable verifier instance
DecodedJWT jwt = verifier.verify(token);
} catch (JWTVerificationException exception){
//Invalid signature/claims
}JDBC é semelhante ao ODBC, e no principio usava justamente ODBC para conectar-se com o banco de dados. A partir de um código nativo as aplicações Java podiam utilizar qualquer banco de dados que tivesse um driver ODBC disponível. Isso contribuiu bastante para a popularização do JDBC uma vez que existe um driver ODBC para praticamente qualquer banco de dados de mercado. Nesse repositório sera utilizado o JDBC para comunicação com o banco de dados e execução de comandos através de store procedures.
Stored Procedure, que traduzido significa Procedimento Armazenado, é uma conjunto de comandos em SQL que podem ser executados de uma só vez, como em uma função. Ele armazena tarefas repetitivas e aceita parâmetros de entrada para que a tarefa seja efetuada de acordo com a necessidade individual. Nesse projeto foram desenvolvidos. As Stored Procedures implementadas nesse projeto são:
- sp_Clientes_InsertValue
- sp_Clientes_GetValueById
- sp_Clientes_GetAllValues
- sp_Clientes_DeleteValue
Configurando o ambiente TCP para SQL Server
- No menu Iniciar, abra o SQL Server 2014 Configuration Manager.
- Clique em Protocolo para SQLEXPRESS em SQL Server Network Configuration no painel esquerdo. No painel direito, clique com o botão direito do mouse em TCP / IP e selecione Propriedades.
- Na caixa de diálogo Propriedades de TCP / IP, clique na guia Endereços IP.
- Role para baixo para localizar o IPALL. Remova qualquer valor, se presente, para portas dinâmicas TCP e especifique 1433 para porta TCP port.
- Clique OK.
- Novamente, clique com o botão direito do mouse em TCP / IP no painel direito e selecione Ativar.
- No Serviços do SQL Server, clique com o botão direito do mouse em SQL Server (SQLEXPRESS) e selecione Reiniciar.
Firewall
- Para validar se a porta do servido esta liberada, execute o comando
telnet localhost 1433 - Para validar se o servico esta no ar, execute o comando
sc query mssqlserver - Para validar as conexoes na porta, execute o commando
netstat -ano | find "1433"
A maneira mais fácil de instalar é usar o Maven:
pom.xml
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>5.2.6.RELEASE</version>
</dependency>Exemplo de implementação para testes
application.properties
spring.datasource.initialization-mode=always
spring.datasource.platform=@database.platform@
spring.datasource.url=jdbc:sqlserver://{{servidor}};databaseName={{base_de_dados}};integratedsecurity=true
spring.datasource.username={{usuario}}
spring.datasource.password={{senha}}
spring.datasource.driverClassName=com.microsoft.sqlserver.jdbc.SQLServerDriverrepository.java
@Repository
public class ClienteRepository {
private static final String SQL_FIND_ALL = "SELECT @@version;";
private static final BeanPropertyRowMapper<Cliente> ROW_MAPPER = new BeanPropertyRowMapper<>(Cliente.class);
@Autowired
NamedParameterJdbcTemplate jdbcTemplate;
public Iterable<Cliente> findAll() {
return jdbcTemplate.query(SQL_FIND_ALL, ROW_MAPPER);
}Em muitos casos - por exemplo, ao trabalhar com conjuntos de dados muito grandes - não buscamos na base de dados toda a coleção completa e armazenamos na memória. Nesse caso é usar algum tipo de paginação no servidor, onde o servidor envia apenas uma única página de cada vez. Esse é um objeto json de resposta do servidor para casos como esses:
O SMTP ou Simple Mail Transfer Protocol, é uma convenção padrão dedicada ao envio de e-mail. A princípio o protocolo SMTP utilizava por padrão a porta 25 ou 465 (conexão criptografada) para conexão, porém a partir de 2013 os provedores de internet e as operadoras do Brasil passaram a bloquear a porta 25, e começaram a usar a porta 587 para diminuir a quantidade de SPAM. O SMTP é um protocolo que faz apenas o envio de e-mails, isso significa que o usuário não tem permissão para baixar as mensagens do servidor, nesse caso é necessário utilizar um Client de e-mail que suporte os protocolos POP3 ou IMAP como o Outlook, Thunderbird e etc. Para negócios ou empresas pequenas com baixo volume de e-mails, o servidor SMTP gratuito do Google pode ser uma ótima solução e você pode usar o Gmail para enviar o seu e-mail. Eles possuem uma infraestrutura gigante e você pode confiar nos serviços deles para ficar online. Porém, mesmo sendo completamente grátis, tudo tem um limite. De acordo com a documentação do Google, você pode enviar até 100 e-mails a cada período de 24 horas quando envia através do servidor SMTP deles. Ou você também pode pensar nisso como sendo 3 mil e-mails por mês gratuitamente.Dependendo de quantos e-mails você envia ou do tamanho do seu negócio, isto pode ser mais do que suficiente. Se você envia mais de 5 mil e-mails por mês, você vai preferir usar um serviço de e-mail transacional de terceiros ou um serviço premium.
Nesse projeto foi utilizado o spring-boot-email-core para envio de e-mail via SMTP e os testes foram feitos utilizando o serviço do mailtrap.io.
Para instalar o spring-boot-email-core utilize o commando abaixo:
pom.xml
<dependency>
<groupId>it.ozimov</groupId>
<artifactId>spring-boot-email-core</artifactId>
<version>0.6.3</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-mail</artifactId>
</dependency>application.properties
spring.mail.host=smtp.mailtrap.io
spring.mail.port=2525
spring.mail.username=xxxxxxx
spring.mail.password=xxxxxxx
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=trueExemplo de implementação:
@PostMapping(value="/Contato")
public String postCliente(@RequestBody @Valid Contato contato){
// Create a mail sender
JavaMailSenderImpl mailSender = new JavaMailSenderImpl();
mailSender.setHost(this.emailConfig.getHost());
mailSender.setPort(this.emailConfig.getPort());
mailSender.setUsername(this.emailConfig.getUsername());
mailSender.setPassword(this.emailConfig.getPassword());
// Criando um e-emil
SimpleMailMessage mailMessage = new SimpleMailMessage();
mailMessage.setFrom(contato.getEmail());
mailMessage.setTo("rc@feedback.com");
mailMessage.setSubject("New feedback from " + contato.getNome());
mailMessage.setText(contato.getMensagem());
// Enviar e-mail
mailSender.send(mailMessage);
return String.format("Mensagem enviada com sucesso!");
}Teste de unidade é toda a aplicação de teste nas assinaturas de entrada e saída de um sistema. Consiste em validar dados válidos e inválidos via I/O (entrada/saída) sendo aplicado por desenvolvedores ou analistas de teste. Uma unidade é a menor parte testável de um programa de computador. Em programação procedural, uma unidade pode ser uma função individual ou um procedimento. Idealmente, cada teste de unidade é independente dos demais, o que possibilita ao programador testar cada módulo isoladamente. JUnit é uma frameword de teste de unitários para a linguagem de programação Java. JUnit tem sido importante no desenvolvimento TDD e faz parte de uma família de estruturas de teste de unidade que é coletivamente conhecida como xUnit que se originou com SUnit. JaCoCo é uma biblioteca de cobertura de código gratuita para Java, que foi criada pela equipe EclEmma com base nas lições aprendidas com o uso e integração de bibliotecas existentes por muitos anos.
Para instalar o JUnit e JaCoCo utilize o commando abaixo:
pom.xml
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-api</artifactId>
<version>5.6.2</version>
<scope>test</scope>
</dependency>
...
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<version>0.8.3</version>
<executions>
<execution>
<id>prepare-agent</id>
<goals>
<goal>prepare-agent</goal>
</goals>
</execution>
<execution>
<id>report</id>
<phase>prepare-package</phase>
<goals>
<goal>report</goal>
</goals>
</execution>
<execution>
<id>post-unit-test</id>
<phase>test</phase>
<goals>
<goal>report</goal>
</goals>
<configuration>
<!-- Sets the path to the file which contains the execution data. -->
<dataFile>target/jacoco.exec</dataFile>
<!-- Sets the output directory for the code coverage report. -->
<outputDirectory>target/my-reports</outputDirectory>
</configuration>
</execution>
</executions>
<configuration>
<systemPropertyVariables>
<jacoco-agent.destfile>target/jacoco.exec</jacoco-agent.destfile>
</systemPropertyVariables>
</configuration>
</plugin>
</plugins>
Exemplo de classe teste:
import com.cliente.springboot.model.Contato;
import static org.junit.jupiter.api.Assertions.assertEquals;
import org.junit.jupiter.api.Test;
class SpringbootApplicationTests {
@Test
void contextLoads() {
Contato con = new Contato("zaphod", "zaphod@mail.com","mensagem");
assertEquals(con.getNome(),"zaphod");
}
}Por favor entre em contato conosco via [Email]