EA975 - Laboratório de Engenharia de Software

Transcrição

1 EA975 - Laboratório de Engenharia de Software Turmas K/L Aula 8 Vamos inicialmente especificar com mais detalhes o termo "recurso" utilizado no estilo arquitetural REST. Em REST, recursos são uma forma de estruturar e processar a informação. Recursos são agrupados em classes (categorias) organizadas hierarquicamente (como arquivos e diretórios). Cada recurso possui um estado, as informações que caracterizam o recurso. Na criação de um recurso é atribuída a classe a qual o recurso pertence e o estado inicial do recurso. O estado de um recurso pode ser persistente ou transiente, podendo ser acessado, modificado ou removido (causando a remoção do respectivo recurso). Um ou mais atributos do estado têm a função de diferenciar os recursos de uma classe.

2 Vimos que os objetos de serviço expõem interfaces REST. As operações dessas interfaces correspondem aos métodos do protocolo HTTP: GET, POST, PUT e DELETE. Vamos considerar que essas interfaces definem os métodos get(), post(), put() e delete() para onde as respectivas requisições HTTP serão direcionadas. Como modelar essas interfaces REST? Em UML interfaces são modeladas como um conjunto de operações que recebem parâmetros e retornam resultados. Na modelagem clássica, tais operações são invocadas localmente, ou seja, por objetos dentro de um mesmo espaço de endereçamento (processo ou thread). A questão aqui é: como modelar interfaces REST usando os recursos da linguagem UML? Vamos considerar cada uma das 4 operações REST. A operação post() cria um recurso de determinada classe, por exemplo, "/produto" ou "/filme/suspense", "/filme/aventura", etc. O recurso é criado com um estado definido por um objeto JSON, por exemplo: {filme: { id: 4534, titulo: 'Janela Indiscreta', categoria: 'suspense', diretor: 'Alfred Hitchcock',... } } Dessa forma podemos definir a operação post() com dois parâmetros de entrada (classe de recurso e estado) e um de saída, um identificador do recurso criado.

3 Comumente um identificador de recurso consiste de um nome acrescido à classe do recurso, por exemplo, "/filme/suspense/4534". Esse nome está associado a um ou mais atributos que identificam univocamente o recurso (atributo id no exemplo anterior) A operação get() recebe como parâmetro um identificador de recurso e retorna o estado atual do recurso (objeto JSON). A operação put() recebe como parâmetro o identificador de um recurso e um objeto JSON com os campos do estado a ser alterado. Por exemplo, para alterar o ano do filme identificado por "/filme/suspense/4534" passamos o objeto JSON "{filme: {ano: 1954}}". A operação delete() recebe como parâmetro o identificador de um recurso e remove esse recurso com o seu respectivo estado mantido pelo servidor. Como os parâmetros das operações get(), post(), put() e delete() são passados do cliente para o servidor via HTTP e como o servidor devolve o resultado da operação? A operação é diretamente associada ao método da requisição HTTP (GET, POST, PUT, DELETE). A classe do recurso é passada como o recurso da requisição HTTP, por exemplo, GET /filme/suspense O estado do recurso (operações post() e put()) é passado no corpo (payload) da requisição HTTP. O resultado da operação é retornado na resposta da requisição HTTP. O código de retorno 200 OK indica que a operação foi realizada com sucesso no servidor. Caso um objeto JSON seja retornado pela operação, o parâmetro Content-Type da resposta deve ser application/json.

4 Para as operações get(), put() e delete() é possível também especificar um conjunto de recursos de interesse sobre os quais essas operações serão aplicadas. Existem basicamente três maneiras de especificar um conjunto de recursos (que podem ser combinadas): 1. Fornecendo parte da hierarquia de nomes na requisição HTTP, por exemplo, GET /filme/aventura (todos os filmes da categoria aventura). 2. Fornecendo como payload da requisição HTTP um objeto JSON com atributos que os estados dos recursos devem conter, por exemplo: GET /filme... {filme: {categoria: 'aventura', ano: 1954}} 3. Fornecendo como parâmetros da requisição HTTP os atributos que diferenciam o recurso em sua classe, por exemplo: GET /filme?categoria=aventura&ano=1954 Vamos iniciar a especificação dos recursos que a aplicação irá manipular. Esses recursos têm seus estados modelados em JSON, o mesmo formato utilizado no armazenamento persistente e na comunicação entre os componentes da aplicação. Em UML podemos modelar um objeto JSON por meio de uma classe com um estereótipo (por exemplo, <<json>>). O nome da classe especifica a classe do recurso. Os atributos do objeto JSON são mapeados nos atributos da classe, cujos tipos devem refletir aqueles comumente utilizados em JSON: strings; números (inteiros, floats); booleanos (true, false); arrays (vetores); objetos (JSON). Não é necessário definir as operações para os objetos JSON, pois estas serão definidas nas interfaces REST e CRUD.

5 Até então representamos as interfaces providas pelos componentes por meio de um nome e um ícone (bolinha). Essas interfaces podem ser detalhadas por meio de classes com o estereótipo <<interface>>. Para cada interface do diagrama de componentes crie uma diagrama de classes com os métodos suportados pela interface, notadamente os métodos REST providos pelos componentes de serviço e os métodos CRUD providos pelos componentes de persistência. O que fazer agora? Faça diagramas UML de classes detalhando os seguintes elementos da aplicação: As interfaces providas pelos componentes identificados na aula anterior. Defina nessas interfaces as operações REST e CRUD necessárias à sua aplicação. os objetos JSON que representarão os recursos trocados entre os componentes identificados na aula anterior, notadamente entre os componentes de interação e de serviço e entre os componentes de serviço e de persistência (ou seja, entre as fronteiras das 3 camadas da arquitetura). Use um estereótipo nos atributos que diferenciarão os recursos da classe, por exemplo <<key>>. Para cada caso de uso, identifique a sequência temporal de mensagens trocadas entre as camadas da arquitetura (UML possui dois diagramas para tal: diagramas de sequência e de colaboração). Use a ferramenta Astah para elaborar os diagramas de classes e, opcionalmente, de sequência e/ou colaboração..