将@PathParam传递给Jersey中的Sub Resource定位器类

Héc*_*tor 5 java rest jersey

我想以这种方式调用我的api端点:

http://.../companies/1/employees
Run Code Online (Sandbox Code Playgroud)

并使用代码1检索公司的员工.我有以下代码:

@Path("companies")
public class CompanyResource {

    @Context
    ResourceContext resourceContext;

    @GET
    @Path("{idCompany}/employees")
    public EmployeeResource getEmployees() {
        return resourceContext.getResource(EmployeeResource.class);
    }

}
Run Code Online (Sandbox Code Playgroud)

@Path("/employees")
public class EmployeeResource {

    @PathParam("idCompany")
    String idCompany;

    @GET
    public List<Employee> getEmployees() {
        // here "idCompany" is null
        //some code
    }
}
Run Code Online (Sandbox Code Playgroud)

但路径参数为空.我究竟做错了什么?有没有更正确的方法来做到这一点?

dur*_*dur 9

以下是JAX-RS 2.0可能解决方案的摘要:

  • 使用构造函数请求作用域子资源:

    @Path("companies")
    public class CompanyResource {
    
        @Path("{idCompany}/employees")
        public EmployeeResource getEmployees(@PathParam("idCompany") String companyId) {
            return new EmployeeResource(companyId);
        }
    }  
    
    public class EmployeeResource {
    
        private String companyId
    
        public EmployeeResource(String companyId) {
            this.companyId = companyId;
        }
    
        @GET
        public List<Employee> getEmployees() {
            //some code
        }
    }
    
    Run Code Online (Sandbox Code Playgroud)

    缺点:

    • 没有依赖注入
  • 使用ResourceContext #initResource(Class)请求作用域子资源:

    @Path("companies")
    public class CompanyResource {
    
        @Context
        private ResourceContext resourceContext;
    
        @GET
        @Path("{idCompany}/employees")
        public EmployeeResource getEmployees(@PathParam("idCompany") String companyId) {
            EmployeeResource employeeResource = new EmployeeResource(companyId);
            return resourceContext.initResource(employeeResource);
        }
    }  
    
    public class EmployeeResource {
    
        @Context
        private Request request;
    
        private String companyId
    
        public EmployeeResource(String companyId) {
            this.companyId = companyId;
        }
    
        @GET
        public List<Employee> getEmployees() {
            //some code
        }
    }
    
    Run Code Online (Sandbox Code Playgroud)

    缺点:

  • 使用ResourceContext#getResource(Class)请求作用域子资源:

    @Path("companies")
    public class CompanyResource {
    
        @Context
        private ResourceContext resourceContext;
    
        @GET
        @Path("{idCompany}/employees")
        public EmployeeResource getEmployees(@PathParam("idCompany") String companyId) {
            EmployeeResource employeeResource = resourceContext.getResource(EmployeeResource.class);
            employeeResource.setCompanyId(companyId);
            return employeeResource;
        }
    }  
    
    public class EmployeeResource {
    
        @Context
        private Request request;
    
        private String companyId
    
        public setCompanyId(String companyId) {
            this.companyId = companyId;
        }
    
        @GET
        public List<Employee> getEmployees() {
            //some code
        }
    }
    
    Run Code Online (Sandbox Code Playgroud)

    缺点:

  • 使用@PathParamas字段请求作用域子资源:

    @Path("companies")
    public class CompanyResource {
    
        @Context
        private ResourceContext resourceContext;
    
        @GET
        @Path("{idCompany}/employees")
        public EmployeeResource getEmployees() {
            return resourceContext.getResource(EmployeeResource.class);
        }
    }  
    
    public class EmployeeResource {
    
        @Context
        private Request request;
    
        @PathParam("idCompany")
        private String companyId;
    
        @GET
        public List<Employee> getEmployees() {
            // some code
        }
    }
    
    Run Code Online (Sandbox Code Playgroud)

    缺点:

  • 请求带有返回类型的作用域子资源Class<T>:

    @Path("companies")
    public class CompanyResource {
    
        @GET
        @Path("{idCompany}/employees")
        public Class<EmployeeResource> getEmployees() {
            return EmployeeResource.class;
        }
    }  
    
    public class EmployeeResource {
    
        @Context
        private Request request;
    
        @PathParam("idCompany")
        private String companyId;
    
        @GET
        public List<Employee> getEmployees() {
            // some code
        }
    }
    
    Run Code Online (Sandbox Code Playgroud)

    缺点:

  • 使用@PathParamas方法参数请求作用域子资源:

    @Path("companies")
    public class CompanyResource {
    
        @Context
        private ResourceContext resourceContext;
    
        @GET
        @Path("{idCompany}/employees")
        public Class<EmployeeResource> getEmployees() {
            return resourceContext.getResource(EmployeeResource.class);
        }
    }  
    
    public class EmployeeResource {
    
        @Context
        private Request request;
    
        @GET
        public List<Employee> getEmployees(@PathParam("idCompany") String companyId) {
            // some code
        }
    }
    
    Run Code Online (Sandbox Code Playgroud)

    缺点:

  • 具有@PathParamas方法参数的Singleton子资源:

    @Path("companies")
    public class CompanyResource {
    
        @Context
        private ResourceContext resourceContext;
    
        @GET
        @Path("{idCompany}/employees")
        public Class<EmployeeResource> getEmployees() {
            return resourceContext.getResource(EmployeeResource.class);
        }
    }  
    
    @Singleton
    public class EmployeeResource {
    
        @Context
        private Request request;
    
        @GET
        public List<Employee> getEmployees(@PathParam("idCompany") String companyId) {
            // some code
        }
    }
    
    Run Code Online (Sandbox Code Playgroud)

    缺点:

也可以看看:

  • 我向下滚动整个答案,寻找允许DI的选项. (3认同)

Pau*_*tha 6

我无法重现空 ID,但有几点需要指出

  • @GET应该从EmployeeResource getEmployees()方法中删除。子资源定位器不应具有 HTTP 方法注释。查看子资源
  • 另外,@PathEmployeeResource被忽略(不需要)。没问题,只是觉得你应该知道。

下面是使用Jersey 测试框架的完整工作示例。这是我使用的测试依赖项

<dependency>
    <groupId>org.glassfish.jersey.test-framework.providers</groupId>
    <artifactId>jersey-test-framework-provider-grizzly2</artifactId>
    <version>${jersey2.version}</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.glassfish.jersey.media</groupId>
    <artifactId>jersey-media-json-jackson</artifactId>
    <version>${jersey2.version}</version>
    <scope>test</scope>
</dependency>
Run Code Online (Sandbox Code Playgroud)

您可以像运行任何其他 JUnit 测试一样运行它

import java.util.ArrayList;
import java.util.List;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.container.ResourceContext;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import org.glassfish.jersey.server.ResourceConfig;
import org.glassfish.jersey.test.JerseyTest;
import org.junit.Test;
import static junit.framework.Assert.*;

public class LocatorTest extends JerseyTest {

    public static class Employee {
        public String firstName;
        public String lastName;
        public Employee(){}
        public Employee(String firstName, String lastName) {
            this.firstName = firstName;
            this.lastName = lastName;
        }
    }

    public static class Company {
        public String companyId;
        public List<Employee> employees;
        public Company(){}
        public Company(String companyId, List<Employee> employees) {
            this.companyId = companyId;
            this.employees = employees;
        }
    }

    @Path("companies")
    public static class CompanyResource {

        @Context
        private ResourceContext resourceContext;

        @Path("{companyId}/employees")
        public EmployeeResource getEmployees() {
            return resourceContext.getResource(EmployeeResource.class);
        }
    }

    public static class EmployeeResource {

        @PathParam("companyId")
        public String companyId;

        @GET
        @Produces(MediaType.APPLICATION_JSON)
        public Company getCompanyEmployees() {
            List<Employee> emps = new ArrayList<>();
            emps.add(new Employee("pee", "skillet"));
            emps.add(new Employee("Stack", "Overflow"));
            Company co = new Company(companyId, emps);
            return co;
        }
    }

    @Override
    public ResourceConfig configure() {
        return new ResourceConfig(CompanyResource.class);
    }

    @Test
    public void doit() {
        Response response = target("companies/1234/employees").request().get();
        assertEquals(200, response.getStatus());
        Company co = response.readEntity(Company.class);
        assertNotNull(co.companyId);
        assertEquals("1234", co.companyId);
        assertEquals(2, co.employees.size());
        response.close();
    }
}
Run Code Online (Sandbox Code Playgroud)