sparkjava:路由必须是main方法吗?

时间:2016-01-24 13:38:22

标签: routes spark-java

我是sparkjava的新手,总体上喜欢它。但是,是否必须在main方法中定义新的路由/端点?对于任何重要的Web应用程序,这将导致一个非常长的主方法,或者我需要有多个主要方法(因此在多个实例之间拆分服务器资源)。

这两个sparkjava文档页面似乎在主方法中定义了路径:http://sparkjava.com/documentation.html#routeshttp://sparkjava.com/documentation.html#getting-started

还有其他方法可以做到这一点,我没有看到吗?粗略的谷歌搜索并没有向我展示更好的方式...

======

以下是我根据安德鲁的答案做的完整解决方案。在我看来,在main方法之外添加端点应该是sparkjava文档页面的一部分:

主要方法:

public static void main(String[] args) {
    //Do I need to do something more with the Resource instance so that sparkjava notices it and/or reads the routes?
    Resource resource= new Resource(new Service());
}

我的资源:

import static spark.Spark.*;
class Resource{

    private Service service;

    Resource(Service service){
        this.service = service;
        setupEndpoints();
    }

    private void setupEndpoints() {

        get("/user/:id", "application/json",(request, response)
                -> service.find(request.params(":id")), new JsonTransformer());

        get("/users", "application/json", (request, response)
                -> service.findAll(), new JsonTransformer());
    }
}

我的服务:

public class Service {

    public Object find(String id) {
        return null;
    }

    public Object findAll() {
        return null;
    }
}

我的JsonTransformer:

import spark.ResponseTransformer;
public class JsonTransformer implements ResponseTransformer {
    @Override
    public String render(Object model) throws Exception {
        return null;
    }
}

4 个答案:

答案 0 :(得分:8)

您可以根据需要设置路线。你只需要在主线程中设置调用方法。 e.g。

 public static void main(String[] args){
     Resource resource= new Resource(new Service());
 }

 class Resource{

    private Service service;

    Resource(Service service){
      this.service = service;
      setupEndpoints();
    }

    private void setupEndpoints() {

      get("/user/:id", "application/json",(request, response)
            -> service.find(request.params(":id")), new JsonTransformer());

      get("/users", "application/json", (request, response)
            -> service.findAll(), new JsonTransformer());
    }
 }

答案 1 :(得分:7)

这是一个可以在有多个端点进行配置时使用的设计理念:

首先,创建一个构建器界面:

@Pattern(regexp = "[\\w|-]{1,5}")
private String data;

现在,让我们假设您拥有许多其他休息端点资源中的一个:

public interface EndpointBuilder {
    void configure(Service spark, String basePath);
}

最后,创建一个RestContext类,它将保存spark实例,并使您能够配置所需的任何路径:

public class CustomerEndpoint implements EndpointBuilder {

    private final CustomerService customerService;

    public CustomerEndpoint(CustomerService service) {
        this.customerService = service;
    }

    @Override
    public void configure(Service spark, String basePath) {

        spark.get(basePath + "/customer", (req, res) -> {
            return "hello";
        });
    }
}

您应该能够在main方法中使用此上下文类(并且可选地在您的测试类中):

public class RestContext {

    private static final Logger logger = LoggerFactory.getLogger(RestContext.class);

    private final Service spark;

    private final String basePath;

    public RestContext(int port, String basePath) {
        this.basePath = basePath;
        spark = Service.ignite().port(port); // import spark.Service;
    }

    public void addEndpoint(EndpointBuilder endpoint) {

        endpoint.configure(spark, basePath);
        logger.info("REST endpoints registered for {}.", endpoint.getClass().getSimpleName());
    }

    // Then you can even have some fun:
    public void enableCors() {

        spark.before((request, response) -> {
            response.header("Access-Control-Allow-Origin", "*");
            response.header("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE, OPTIONS");
            response.header("Access-Control-Allow-Headers", "Content-Type, api_key, Authorization");
        });

        logger.info("CORS support enabled.");
    }
}

Obs。:Since version 2.5,spark java通过 Service.ignite() api支持多个实例。

答案 2 :(得分:3)

您还可以将Spring集成到Spark应用程序中。这就是我配置路线的方式。

@Configuration
public class RoutesConfiguration {
    RoutesConfiguration() {
        get("/hello", (req, res) -> "Hello World!");
    }
}

这使我可以避免SparkApp的Main方法中的设置调用步骤。

答案 3 :(得分:1)

好吧,spark-java适用于那些我不想要大量额外配置的人。

所以,我只是在控制器中放置了一个方法,并将其命名为clarifyRoutes。

对于示例应用程序:

public class LoginController {

    public static void declareRoutes(){
        get(Path.Web.LOGIN, LoginController.serveLoginPage);
        post(Path.Web.LOGIN, LoginController.handleLoginPost);
        post(Path.Web.LOGOUT, LoginController.handleLogoutPost);
    }

    public static Route serveLoginPage = (Request request, Response response) -> {
        Map<String, Object> model = new HashMap<>();
        model.put("loggedOut", removeSessionAttrLoggedOut(request));
        model.put("loginRedirect", removeSessionAttrLoginRedirect(request));
        return ViewUtil.render(request, model, Path.Template.LOGIN);
    };

因此,在我的应用程序中,我像这样初始化所有路由:

 // Routes

 Class[] controllers = {
          IndexController.class,
          LoginController.class,
          SandboxController.class,
          ServicesController.class };

 for (Class controller: controllers) {
         Method m = controller.getMethod("declareRoutes");
         m.invoke(m);
 }

 // Catch all
 declareCatchAllRoute();

declareCatchAllRoute()只是:

private void declareCatchAllRoute() {
    get("*", ViewUtil.notFound);
}

可以很好地满足我的需求,不需要任何新的抽象。

HTH