泽西2 +杰克逊注释/ @JsonIgnore

时间:2018-05-03 06:01:54

标签: java spring-mvc jersey

  编辑:现在更具体一点,我注意到一个冲突,我想在下面使用BOTH依赖项:

    <dependency>
        <groupId>org.glassfish.jersey.media</groupId>
        <artifactId>jersey-media-json-binding</artifactId>
        <version>2.27</version>
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.media</groupId>
        <artifactId>jersey-media-json-jackson</artifactId>
        <version>2.3.1</version>
    </dependency>

基本上,我试图忽略一个属性(@JsonIgnore),但我的杰克逊注释都没有起作用。甚至是@JsonProperty。我试图在getter和setters方法中添加@JsonIgnore,但行为相同。

我还尝试按照官方文档,尝试了不同的库

  • import org.codehaus.jackson.annotate.JsonIgnore; (相同的行为)
  • import com.fasterxml.jackson.annotation.JsonIgnore; (相同的行为)

我看到类似的帖子,例如#12595351

来自Controller的响应,不应显示Revoked。属性,但我收到了这个回复:

  

实际回复

{
    "accessToken": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJqb2huLmRvZUBleGFtcGxlLmNvbSIsImlzcyI6ImpvaG4uZG9lQGV4YW1wbGUuY29tIiwiaWF0IjoxNTI1MzI1Nzk1LCJleHAiOjE1MjUzMzI5OTV9.uri3pRwXQHHG09F-wM40qfuRMRVu_WBK3HlfquGvwYc",
    "expiresAt": "2018-05-03T07:36:35.087Z[UTC]",
    "expiresIn": 7199,
    "issuedAt": "2018-05-03T05:36:35.087Z[UTC]",
    "refreshToken": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJqb2huLmRvZUBleGFtcGxlLmNvbSIsImlzcyI6ImpvaG4uZG9lQGV4YW1wbGUuY29tIiwiaWF0IjoxNTI1MzI1Nzk1LCJleHAiOjE1MjU5MzA1OTV9.xj2oytAVwiAIR8U2upJkPH_BdORuJUNbiicvuvGFz0w",
    "revoked": false,
    "type": "Bearer"
}
  

预期回应

{
    "accessToken": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJqb2huLmRvZUBleGFtcGxlLmNvbSIsImlzcyI6ImpvaG4uZG9lQGV4YW1wbGUuY29tIiwiaWF0IjoxNTI1MzI1Nzk1LCJleHAiOjE1MjUzMzI5OTV9.uri3pRwXQHHG09F-wM40qfuRMRVu_WBK3HlfquGvwYc",
    "expiresAt": "2018-05-03T07:36:35.087Z[UTC]",
    "expiresIn": 7199,
    "issuedAt": "2018-05-03T05:36:35.087Z[UTC]",
    "refreshToken": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJqb2huLmRvZUBleGFtcGxlLmNvbSIsImlzcyI6ImpvaG4uZG9lQGV4YW1wbGUuY29tIiwiaWF0IjoxNTI1MzI1Nzk1LCJleHAiOjE1MjU5MzA1OTV9.xj2oytAVwiAIR8U2upJkPH_BdORuJUNbiicvuvGFz0w",
    "type": "Bearer"
}
  

pom.xml(使用Maven)

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

<modelVersion>4.0.0</modelVersion>

<groupId>com.wedhany.fimper</groupId>
<artifactId>fimper</artifactId>
<packaging>war</packaging>
<version>0.0.1-SNAPSHOT</version>
<name>fimper</name>

<build>
    <finalName>fimper</finalName>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>2.5.1</version>
            <inherited>true</inherited>
            <configuration>
                <source>8</source>
                <target>8</target>
            </configuration>
        </plugin>
    </plugins>
</build>

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.glassfish.jersey</groupId>
            <artifactId>jersey-bom</artifactId>
            <version>${jersey.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <dependency>
        <groupId>com.google.code.gson</groupId>
        <artifactId>gson</artifactId>
        <version>2.8.2</version>
    </dependency>
    <dependency>
        <groupId>commons-logging</groupId>
        <artifactId>commons-logging</artifactId>
        <version>1.2</version>
    </dependency>
    <dependency>
        <groupId>de.mkammerer</groupId>
        <artifactId>argon2-jvm</artifactId>
        <version>2.4</version>
    </dependency>
    <dependency>
        <groupId>io.jsonwebtoken</groupId>
        <artifactId>jjwt</artifactId>
        <version>0.9.0</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.11</version>
    </dependency>
    <dependency>
        <groupId>org.apache.commons</groupId>
        <artifactId>commons-lang3</artifactId>
        <version>3.7</version>
    </dependency>
    <dependency>
        <groupId>org.apache.tomcat</groupId>
        <artifactId>tomcat-dbcp</artifactId>
        <version>9.0.1</version>
    </dependency>
    <dependency>
        <groupId>org.flywaydb</groupId>
        <artifactId>flyway-core</artifactId>
        <version>5.0.7</version>
    </dependency>
    <dependency>
        <groupId>org.modelmapper</groupId>
        <artifactId>modelmapper</artifactId>
        <version>1.1.0</version>
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.containers</groupId>
        <artifactId>jersey-container-servlet</artifactId>
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.inject</groupId>
        <artifactId>jersey-hk2</artifactId>
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.media</groupId>
        <artifactId>jersey-media-json-binding</artifactId>
        <version>2.27</version>
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.media</groupId>
        <artifactId>jersey-media-json-jackson</artifactId>
        <version>2.3.1</version>
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.ext</groupId>
        <artifactId>jersey-spring4</artifactId>
        <version>2.27</version>
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.test-framework.providers</groupId>
        <artifactId>jersey-test-framework-provider-jdk-http</artifactId>
        <version>${jersey.version}</version>
    </dependency>
    <dependency>
        <groupId>org.hibernate</groupId>
        <artifactId>hibernate-core</artifactId>
        <version>5.2.17.Final</version>
    </dependency>
    <dependency>
        <groupId>org.hibernate</groupId>
        <artifactId>hibernate-validator</artifactId>
        <version>6.0.9.Final</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-core</artifactId>
        <version>${springframework.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>${springframework.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-tx</artifactId>
        <version>${springframework.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-orm</artifactId>
        <version>${springframework.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-web</artifactId>
        <version>${springframework.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-webmvc</artifactId>
        <version>${springframework.version}</version>
    </dependency>
</dependencies>

<profiles>
    <profile>
        <id>Development</id>
        <dependencies>
            <dependency>
                <groupId>com.github.blocoio</groupId>
                <artifactId>faker</artifactId>
                <version>1.2.7</version>
            </dependency>
        </dependencies>
    </profile>
</profiles>

<properties>
    <jersey.version>2.27</jersey.version>
    <springframework.version>4.3.16.RELEASE</springframework.version>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

  

Token.java(我的模型)

package com.wedhany.models;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.wedhany.models.enums.token.GrantType;
import com.wedhany.models.enums.token.Type;

import java.util.Date;

public class Token {

/**
 * Attributes
 */
private String accessToken;
private String refreshToken;

@JsonIgnore
private boolean revoked;

@JsonProperty("expires_at")
private Date expiresAt;
private Date issuedAt;

private GrantType grantType;
private Type type;

private User user;

/**
 * @return Token TTL in seconds.
 */
public long getExpiresIn() {
    return this.expiresAt.getTime() < new Date().getTime()
            ? 0
            : (this.expiresAt.getTime() - new Date().getTime()) / 1000;
}

/**
 * @return Token that will grant authentication and authorization.
 */
public String getAccessToken() {
    return accessToken;
}

/**
 * @param accessToken Token string.
 */
public void setAccessToken(String accessToken) {
    this.accessToken = accessToken;
}

/**
 * @return Token used to request a new token.
 */
public String getRefreshToken() {
    return refreshToken;
}

/**
 * @return Invalid token if true.
 */
public boolean isRevoked() {
    return revoked;
}

/**
 * @param revoked True for invalid.
 */
public void setRevoked(boolean revoked) {
    this.revoked = revoked;
}

/**
 * @param refreshToken Refresh token.
 */
public void setRefreshToken(String refreshToken) {
    this.refreshToken = refreshToken;
}

/**
 * @return Token's expiration date.
 */
public Date getExpiresAt() {
    return expiresAt;
}

/**
 * @param expiresAt Token's expiration date.
 */
public void setExpiresAt(Date expiresAt) {
    this.expiresAt = expiresAt;
}

/**
 * @return Date where the token was requested.
 */
public Date getIssuedAt() {
    return issuedAt;
}

/**
 * @param issuedAt Date where the token was requested.
 */
public void setIssuedAt(Date issuedAt) {
    this.issuedAt = issuedAt;
}

/**
 * @return Type of the token.
 */
public Type getType() {
    return type;
}

/**
 * @param type Type of the token.
 */
public void setType(Type type) {
    this.type = type;
}

/**
 * @return How the token was claimed.
 */
public GrantType getGrantType() {
    return grantType;
}

/**
 * @param grantType Set token type of grant.
 */
public void setGrantType(GrantType grantType) {
    this.grantType = grantType;
}

/**
 * @return Owner of the token
 */
public User getUser() {
    return user;
}

/**
 * @param user Token's owner.
 */
public void setUser(User user) {
        this.user = user;
    }
}
  

AuthenticationController

package com.wedhany.controllers;

import com.wedhany.exceptions.AuthorizationException;
import com.wedhany.models.Token;
import com.wedhany.models.User;
import com.wedhany.services.AuthenticationService;
import org.springframework.beans.factory.annotation.Autowired;

import javax.security.sasl.AuthenticationException;
import javax.ws.rs.*;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;

@Path("auth")
public class AuthenticationController {

@Autowired
private AuthenticationService authenticationService;

@POST
@Path("login")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
public Response login(User user, @HeaderParam("user-agent") String userAgent) throws Exception {
    try {
        // Authenticate the user using the credentials provided
        this.authenticationService.authenticate(user.getEmail(), user.getPassword());

        // Issue a token for the user
        Token token = this.authenticationService.issueToken(user.getEmail(), userAgent);

        // Return the token on the response
        return Response.ok(token).build();

    } catch (AuthorizationException e) {
        return Response.status(Response.Status.UNAUTHORIZED).build();
    } catch (AuthenticationException e) {
        return Response.status(Response.Status.FORBIDDEN).build();
    }
}

@POST
@Path("refresh")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
public Response refresh(Token token, @HeaderParam("user-agent") String userAgent) throws AuthenticationException {
    return Response.status(Response.Status.CREATED)
            .entity(this.authenticationService.refresh(token.getRefreshToken(), userAgent))
            .build();
}

@POST
@Path("register")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
public Response register(User user) {
    user = authenticationService.save(user);

    return Response.status(Response.Status.CREATED)
            .entity(user)
            .build();
}
}

5 个答案:

答案 0 :(得分:2)

选择以下任一项,但不能同时选择以下两项:

<!-- JSON-B (JSR-347) support -->
<dependency>
    <groupId>org.glassfish.jersey.media</groupId>
    <artifactId>jersey-media-json-binding</artifactId>
    <version>2.27</version>
</dependency>
<!-- Jackson 2.x support -->
<dependency>
    <groupId>org.glassfish.jersey.media</groupId>
    <artifactId>jersey-media-json-jackson</artifactId>
    <version>2.27</version>
</dependency>

Jackson和JSON-B都提供了来自Java绑定的JSON:

如果你想去annotations,你应该使用杰克逊@JsonIgnore。例如,要忽略属性,请使用jersey-media-json-binding

如果你想去annotations,你应该使用JSON-B @JsonbTransient。例如,要忽略属性,请使用here

您正在使用jersey-bom,一个依赖关系管理工件,它可以整合和集中管理依赖项版本(而无需实际将依赖项添加到项目中)。

因此,您不需要指定org.glassfish.jersey工件的版本。使用以下之一(不含version):

<!-- JSON-B (JSR-347) support -->
<dependency>
    <groupId>org.glassfish.jersey.media</groupId>
    <artifactId>jersey-media-json-binding</artifactId>
</dependency>
<!-- Jackson 2.x support -->
<dependency>
    <groupId>org.glassfish.jersey.media</groupId>
    <artifactId>jersey-media-json-jackson</artifactId>
</dependency>

查看更多详情hereSwitch

答案 1 :(得分:0)

以下代码适用于jackson版本2.8.10

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;

public class JsonIgnoreExample {
    private static class BeanWithIgnore {
        @JsonIgnore
        public int id;
        public String name;

        public BeanWithIgnore(int id, String name) {
            this.id = id;
            this.name = name;
        }
    }

    public static void main(String[] args) throws JsonProcessingException {
        BeanWithIgnore bean = new BeanWithIgnore(1, "My bean");
        String result = new ObjectMapper().writeValueAsString(bean);
        System.out.println(result); // {"name":"My bean"}
    }
}

答案 2 :(得分:0)

这对我有用,我在我的pom.xml中有这些库:

        <dependency>
            <groupId>org.glassfish.jersey.media</groupId>
            <artifactId>jersey-media-json-jackson</artifactId>
            <version>${org.glassfish.jersey.core.version}</version>
            <scope>provided</scope>
        </dependency>


        <!-- ************** Jackson XML and JSON API ************************* -->          
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>${jackson-version}</version>
        </dependency>   

       <dependency>
            <groupId>org.glassfish.jersey.media</groupId>
            <artifactId>jersey-media-moxy</artifactId>
            <version>${org.glassfish.jersey.core.version}</version>             
            <scope>provided</scope>
        </dependency>

只需从您的类中删除该属性并添加此注释:

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;

@JsonIgnoreProperties(ignoreUnknown=true)
public class Token {
// ... keep only the properties you want to map

这将告诉Jackson只绑定您实际拥有的属性,忽略JSON输出中可能存在的所有其他属性。

答案 3 :(得分:0)

基本上 jersey-media-json-binding jersey-media-json-jackson 具有类似的行为。你不能同时使用这两种方法。 jersey-media-json-jackson没有工作的原因是因为更具优先权的提供者是jersey-media-json-binding。

答案 4 :(得分:0)

我不知道您项目的整个配置,所以我们认为您可以这样做,手动创建JSON,然后发送到响应,如:

ObjectMapper maper = new ObjectMapper();
return Response.ok(maper.writer().withDefaultPrettyPrinter().writeValueAsString(tokenObject));

它可以像手动转换一样工作而不使用泽西岛的自动序列化 注意:这个东西不值得推荐,但应该可行。

转换时需要此依赖项:

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.2.3</version>
</dependency>