O objetivo deste sistema e realizar a simulação do processo de compra e venda de ações na bolsa de valores de forma automatizada. Desta forma, o usuario poderá registrar e consultar contas, além de criar, alterar, remover e buscar monitoramentos em determinadas empresas.
Para compilar ou rodar esta aplicação você precisa de:
- JDK 1.8
- MySQL
- Maven 3
Para poder utilizar a aplicação normalmente se relacionando com o banco de dados é necessário criar uma nova conexão do banco com as seguintes configurações:
Conexão: localhost ou 127.0.0.1
Usuário: root
Senha: superabc
Porta: 3306
Após configurar a conexão e se conectar nela, crie um novo banco com o seguinte comando:
CREATE DATABASE acoesbolsa;
O usuário também poderá incluir sua própria conexão assim como o banco, porém para isso deve ser realizado o download do projeto e adicionar essas alterações no arquivo application.properties.
Para poder rodar o app na sua máquina, após realizar as configurações anteriores, siga as seguintes etapas:
- Faça o download do JAR da aplicação.
- Abra o console e vá até a pasta onde o JAR foi baixado.
- No diretório correto execute o seguinte comando:
java -jar ProjetoAcoesBolsa-0.0.1-SNAPSHOT.jar
- A aplicação agora estará rodando.
Na conta, dentro do sistema, pode ser realizado duas operações:
- Cadastrar nova conta
- Consultar conta existente
| ENDPOINT | PARAMETROS | TIPO |
|---|---|---|
| /conta/cadastrar | POST |
Para realizar o cadastro de uma nova conta, realize uma chamada HTTP seguindo as definições acima.
Ademais, é necessário enviar juntamente um corpo com base nesta estrutura:
{
"email" : "exemplo@gmail.com",
"saldo" : 10000
}
O email deve ser 'gmail' para garantir o envio do email quando a negociação for realizada.
| ENDPOINT | PARAMETROS | TIPO |
|---|---|---|
| /conta/{id} | id = id da conta | GET |
Para consultar uma conta existente no sistema, realiza uma chamada http seguindo as definições acima.
O retorno da requisição será um arquivo no formato JSON assim como o do seguinte exemplo:
{
"id" : 1,
"email" : "testconsulta@gmail.com",
"saldo" : 10000,
"quantidadeAcoes" : 0,
"monitoramentos" : [],
"negociacoes" : []
}
No monitoramento de ações, o usuário possui quatro operações que podem ser realizadas, sendo elas:
- Cadastrar novo monitoramento
- Consultar monitoramento
- Alterar monitoramento
- Remover monitoramento
| ENDPOINT | PARAMETROS | TIPO |
|---|---|---|
| /conta/{id}/monitoramentos/cadastrar | id = id da conta | POST |
Para realizar o cadastro de monitoramento no sistema deve enviar uma requisição HTTP seguindo as definições acima.
Ademais, juntamente na requisição deve-se enviar um corpo com base nesta estrutura:
{
"precoCompra" : 10.1,
"precoVenda" : 10.9,
"nomeEmpresa" : "Intel"
}
O nome da empresa deve ser Intel ou SoftExpert.
| ENDPOINT | PARAMETROS | TIPO |
|---|---|---|
| /conta/{id}/monitoramentos | id = id da conta | GET |
Para realizar a consulta dos monitoramentos relativo a conta, deve se enviar uma requisição HTTP seguindo as definições acima.
O retorno da requisição será um arquivo no formato JSON assim como o do seguinte exemplo:
{
"id" : 1,
"precoCompra" : 10.1,
"precoVenda" : 10.9,
"nomeEmpresa" : "Intel"
}
| ENDPOINT | PARAMETROS | TIPO |
|---|---|---|
| /conta/{id}/monitoramentos/atualizar | id = id da conta | PUT |
Para realizar a atualização dos monitoramentos relativo a conta, deve se enviar uma requisição HTTP seguindo as definições acima.
Ademais, é necessário enviar juntamente um corpo com base nesta estrutura:
{
"id" : 1
"precoCompra" : 10.3,
"precoVenda" : 10.55,
"nomeEmpresa" : "Intel",
}
| ENDPOINT | PARAMETROS | TIPO |
|---|---|---|
| /conta/{id}/monitoramentos/{moni_id} | id = id da conta / moni_id = id do monitoramento | DELETE |
Para realizar a remoção dos monitoramentos relativo a conta, deve se enviar uma requisição HTTP seguindo as definições acima. Após enviar a requisição, caso ocorra com sucesso, o monitoramento já estará removido.
| ENDPOINT | PARAMETROS | TIPO |
|---|---|---|
| /conta/{id}/historico | id = id da conta | GET |
Para consultar o histórico de negociações relativo a conta, deve se enviar uma requisição HTTP seguindo as definições acima.
O retorno da requisição será um arquivo no formato JSON assim como o do seguinte exemplo:
{
{
"id" : 1,
"valorNegociado" : 10.5677,
"quantidade" : 957.67,
"nomeEmpresa" : "Intel"
"tipoNegociacao" : "COMPRA",
"data" : "08-06-2018 00:03:06"
},
{
"id" : 2,
"valorNegociado" : 10.8213,
"quantidade" : 957.67,
"tipoNegociacao" : "VENDA",
"data" : "08-06-2018 00:05:11"
}
}
| ENDPOINT | PARAMETROS | TIPO |
|---|---|---|
| /transacoes/iniciar | POST |
As negociações no sistema são realizadas quando uma requisição o inicio das transações é solicitado seguindo as definições acima. Assim, o sistema irá realizar uma operação de atualização de preços das bolsas das empresas em cada 5 segundos, repetindo o processo 100 vezes (8 minutos e 20 segundos).
Após todas as transações serem efetivadas um relatório é gerado no console do usuário mostrando todas as contas e suas negociações efetuadas.
O presente sistema foi desenvolvido separando cada parte do programa em uma camada distinta, assim seguindo a seguinte estrutura:
| PACKAGE | CAMADA |
|---|---|
| com.acoes.bolsa | Main |
| com.acoes.bolsa.modelo | Model |
| com.acoes.bolsa.controlador | Controller |
| com.acoes.bolsa.servicos | Service |
| com.acoes.bolsa.repositorio | Repository |
| com.acoes.bolsa.util | Util |
As camadas de modelo, controlador, serviços e repositórios seguem o padrão normal da arquitetura MVC. O pacote Main contém a classe principal do sistema onde o mesmo será executado. O outro pacoté é um utilitário, contendo a classe que emite o relatório das negociações, e um simulador que possui um método para geração dos preços de forma aleatória.
Neste sistema foram utilizadas as seguintes tecnologias:
* Spring Boot
* Spring MVC
* Spring Data
* Maven
* Mockito
* MySQL
* Hibernate
* JavaMail
* Jackson
* JUnit
* Gson
SpringBoot: A tecnologia Spring Boot foi utilizada neste projeto pela sua praticidade e sua configuração padrão que acabou tornando mais rápido a criação do sistema.
Spring MVC: O Spring MVC foi utilizado no projeto também pela sua facilidade de uso na criação de Web Services. Além do fato de eu possuir uma pequena experiência com a ferramenta.
Spring Data: O Spring Data foi amarrado pelo Maven no projeto ajudando na construção dos repositórios de dados.
Maven: O Maven é uma tecnologia utilizada por padrão pelo Spring Boot, assim foi essencial na criação do projeto.
Mockito: O Mockito foi uma ótima tencologia utilizada no projeto, se destacando pela sua facilidade na criação de testes de requisições HTTP.
MySQL: O banco de dados MySQL foi utilizado no projeto pois é um banco que já utilizo a tempos, tendo uma experiência maior no seu uso.
Hibernate: A tecnologia ORM do Hibernate foi utilizada pela sua indicação do Spring Boot e sua ótima implementação do padrão JPA, que foi fortemente utilizado na camada de modelo.
JavaMail: O JavaMail foi a tecnologia utilizada para o envio de emails por questão de sua popularidade, e consequentemente sua facilidade de implementação e uso.
Jackson: A tecnologia Jackson foi utilizada no projeto por padrão do Spring Boot, ajudando a formatar e emitir as respostas das requisições do usuário.
JUnit: A tecnologia JUnit foi utilizada no projeto por ser um padrão de testes unitários da linguagem de programação Java.
Gson: A biblioteca Gson foi utilizada no projeto durante os testes para transformar os objetos no formato JSON de forma simples e limpa.
Com a construção deste sistema, gostaria de deixar meus agradecimentos a SoftExpert. Consegui aprender muito mesmo durante esta etapa, assim começando a entender o descobrir novas tecnologias que com certeza serão refinadas com o passar do tempo e com novas experiências.