java-restify
Search…
2.x
Início
Anotações
Tipos de conteúdo
Tipos de retorno de método
Requisições assíncronas
Programação reativa
Manipulação de erros
Retry
Clientes HTTP
Spring Framework
Lista de artefatos
Serialização e deserialização
Definição
No
java-restify, serialização se refere ao mecanismo utilizado para escrever o corpo da requisição ; e deserialização se refere ao mecanismo utilizado para ler o corpo da resposta.Ambos são feitos de maneira transparente; a serialização se aplica ao parâmetro do método que representa o corpo (anotado com
@RequestBody, no caso das anotações padrão), e a deserialização se aplica ao tipo de retorno do método.Formatos
O formato utilizado na serialização e deserialização é determinado pelo cabeçalho Content-Type.
O
java-restify fornece várias implementações para lidar com tipos específicos de conteúdo, e essas implementações também influenciam argumentos e retornos de método que podem ser utilizados.Os serializadores, responsáveis por converter um objeto para um determinado formato e escrever no corpo da requisição, são implementações da interface
HttpMessageWriter.Os deserializadores, responsáveis por converter o corpo da resposta (em um formato qualquer) para um objeto, são implementações da interface
HttpMessageReader.Essas duas interfaces extendem
HttpMessageConverter, que fornece o tipo de conteúdo que aquele objeto é capaz de lidar. Caso você precise serializar/deserializar formatos não suportados pelo java-restify, basta implementar HttpMessageWriter (para serialização) ou HttpMessageReader (para deserialização) ou ambos, e registrar seu converter customizado.1
import com.github.ljtfreitas.restify.http.client.message.ContentType;
2
import com.github.ljtfreitas.restify.http.client.message.converter.HttpMessageReadException;
3
import com.github.ljtfreitas.restify.http.client.message.converter.HttpMessageReader;
4
import com.github.ljtfreitas.restify.http.client.message.converter.HttpMessageWriteException;
5
import com.github.ljtfreitas.restify.http.client.message.converter.HttpMessageWriter;
6
import com.github.ljtfreitas.restify.http.client.message.request.HttpRequestMessage;
7
import com.github.ljtfreitas.restify.http.client.message.response.HttpResponseMessage;
8
9
public class MyCustomConverter implements HttpMessageReader<Object>, HttpMessageWriter<Object> {
10
11
@Override
12
public ContentType contentType() {
13
return ContentType.of("text/whatever");
14
}
15
16
@Override
17
public boolean canWrite(Class<?> type) {
18
// verifica se essa implementação é capaz de serializar o tipo de objeto
19
return false;
20
}
21
22
@Override
23
public void write(Object body, HttpRequestMessage httpRequestMessage) throws HttpMessageWriteException {
24
// escreve o objeto no corpo da requisição
25
}
26
27
@Override
28
public boolean canRead(Type type) {
29
// verifica se essa implementação é capaz de deserializar a resposta para esse tipo de objeto
30
return false;
31
}
32
33
@Override
34
public Object read(HttpResponseMessage httpResponseMessage, Type expectedType) throws HttpMessageReadException {
35
// lê a resposta e converte para o objeto esperado
36
return null;
37
}
38
}
39
40
MyApi myApi = new RestifyProxyBuilder()
41
.converters()
42
.add(new MyCustomConverter())
43
.and()
44
.target(MyApi.class)
45
.build();
Copied!
Os únicos
converters registrados por padrão são capazes de deserializar qualquer tipo de conteúdo (Content-Type=*/*), e podem apenas ler respostas.As demais implementações fornecidas pelo
java-restify estão em artefatos separados, e serão registradas automaticamente caso estejam disponíveis no classpath; basta incluir a dependência adequada para o tipo de contúdo que deseja utilizar. O java-restify já fornece objetos capazes de lidar com os formatos application/json, application/xml, text/plain, text/html, application/x-www-form-urlencoded, multipart/form-data e application/octet-stream.1
// todos os formatos listados acima, se disponíveis no classpath, serão registrados
2
MyApi myApi = new RestifyProxyBuilder()
3
.target(MyApi.class)
4
.build();
Copied!
Também é possível implementar um controle fino dos
converters utilizados, selecionando apenas os que fizerem sentido para o seu caso de uso.1
MyApi myApi = new RestifyProxyBuilder()
2
.converters()
3
.json() //apenas json será automaticamente registrado, se estiver disponível no classpath
4
.and()
5
.target(MyApi.class)
6
.build();
7
8
MyApi myApi = new RestifyProxyBuilder()
9
.converters()
10
.xml() //apenas xml será automaticamente registrado, se estiver disponível no classpath
11
.and()
12
.target(MyApi.class)
13
.build();
Copied!
Eventualmente também pode ser necessário desligar o registro automático dos
converters disponíveis no classpath.1
MyApi myApi = new RestifyProxyBuilder()
2
.converters()
3
.discovery()
4
.disabled() // desabilita a descoberta automática de converters
5
.json()
6
.and()
7
.target(MyApi.class)
8
.build();
Copied!
Caso você registre algum
converter customizado, as configurações padrão do java-restify serão sobrescritas e apenas os converters registrados manualmente serão utilizados.1
MyApi myApi = new RestifyProxyBuilder()
2
.converters()
3
.add(new MyCustomConverter()) //apenas esse converter será utilizado
4
.and()
5
.target(MyApi.class)
6
.build();
7
8
// demais converters, se forem necessários, também devem ser incluídos explicitamente
9
MyApi myApi = new RestifyProxyBuilder()
10
.converters()
11
.add(new MyCustomConverter())
12
.json() // além do converter acima, json também será suportado, se estiver disponível no classpath
13
.and()
14
.target(MyApi.class)
15
.build();
Copied!
Formatos suportados
O
java-restify fornece implementações para alguns tipos de conteúdo:Last modified 3yr ago
Copy link