/*@jsxRuntime automatic @jsxImportSource react*/
const {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];
function _createMdxContent(props) {
  const _components = Object.assign({
    p: "p",
    a: "a",
    em: "em",
    h2: "h2",
    code: "code",
    pre: "pre",
    span: "span",
    strong: "strong"
  }, props.components), {Link} = _components;
  if (!Link) _missingMdxReference("Link", true);
  return _jsxs(_Fragment, {
    children: [_jsxs(_components.p, {
      children: ["In ", _jsx(Link, {
        href: "/blog/my-first-vert-x-3-application/",
        passHref: true,
        children: _jsx(_components.a, {
          href: "",
          children: "our pre­vi­ous post"
        })
      }), ", we de­vel­oped a very sim­ple Vert.x 3 ap­pli­ca­tion, and saw how this ap­pli­ca­tion can be tested, pack­aged and ex­e­cuted. That was nice, wasn’t it? Well, ok, that was only the be­gin­ning. In this post, we are going to en­hance our ap­pli­ca­tion to sup­port ", _jsx(_components.em, {
        children: "ex­ter­nal"
      }), " con­fig­u­ra­tion."]
    }), "\n", _jsxs(_components.p, {
      children: ["So just to re­mind you, we have an ap­pli­ca­tion start­ing a HTTP server on the port 8080 and re­ply­ing a po­lite “Hello” mes­sage to all HTTP re­quests. The pre­vi­ous code is avail­able ", _jsx(_components.a, {
        href: "https://github.com/cescoffier/my-vertx-first-app/tree/post-1",
        children: "here"
      }), ". The code de­vel­oped in this post is in the ", _jsx(_components.a, {
        href: "https://github.com/cescoffier/my-vertx-first-app/tree/post-2",
        children: "post-2 branch"
      }), "."]
    }), "\n", _jsxs(_components.h2, {
      id: "so-why-do-we-need-configuration",
      children: [_jsx(_components.a, {
        "aria-hidden": true,
        tabIndex: "-1",
        className: "heading-anchor",
        href: "#so-why-do-we-need-configuration"
      }), "So, why do we need configuration?"]
    }), "\n", _jsx(_components.p, {
      children: "That’s a good ques­tion. The ap­pli­ca­tion works right now, but well, let’s say you want to de­ploy it on a ma­chine where the port 8080 is al­ready taken. We would need to change the port in the ap­pli­ca­tion code and in the test, just for this ma­chine. That would be sad. For­tu­nately, Vert.x ap­pli­ca­tions are con­fig­urable."
    }), "\n", _jsx(_components.p, {
      children: "Vert.x con­fig­u­ra­tions are using the JSON for­mat, so don’t ex­pect any­thing com­pli­cated. They can be passed to ver­ti­cle ei­ther from the com­mand line, or using an API. Let’s have a look."
    }), "\n", _jsxs(_components.h2, {
      id: "no-8080-anymore",
      children: [_jsx(_components.a, {
        "aria-hidden": true,
        tabIndex: "-1",
        className: "heading-anchor",
        href: "#no-8080-anymore"
      }), "No ‘8080’ anymore"]
    }), "\n", _jsxs(_components.p, {
      children: ["The first step is to mod­ify the ", _jsx(_components.code, {
        children: "io.vertx.blog.first.MyFirstVerticle"
      }), " class to not bind to the port 8080, but to read it from the con­fig­u­ra­tion:"]
    }), "\n", _jsx(_components.pre, {
      children: _jsxs(_components.code, {
        className: "hljs language-java",
        children: [_jsx(_components.span, {
          className: "hljs-keyword",
          children: "public"
        }), " ", _jsx(_components.span, {
          className: "hljs-keyword",
          children: "void"
        }), " ", _jsx(_components.span, {
          className: "hljs-title function_",
          children: "start"
        }), _jsx(_components.span, {
          className: "hljs-params",
          children: "(Future<Void> fut)"
        }), " {\n  vertx\n      .createHttpServer()\n      .requestHandler(r -> {\n        r.response().end(", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"<h1>Hello from my first \""
        }), " +\n            ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"Vert.x 3 application</h1>\""
        }), ");\n      })\n      .listen(\n          ", _jsx(_components.span, {
          className: "hljs-comment",
          children: "// Retrieve the port from the configuration,"
        }), "\n          ", _jsx(_components.span, {
          className: "hljs-comment",
          children: "// default to 8080."
        }), "\n          config().getInteger(", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"http.port\""
        }), ", ", _jsx(_components.span, {
          className: "hljs-number",
          children: "8080"
        }), "),\n          result -> {\n            ", _jsx(_components.span, {
          className: "hljs-keyword",
          children: "if"
        }), " (result.succeeded()) {\n              fut.complete();\n            } ", _jsx(_components.span, {
          className: "hljs-keyword",
          children: "else"
        }), " {\n              fut.fail(result.cause());\n            }\n          }\n      );\n}\n"]
      })
    }), "\n", _jsxs(_components.p, {
      children: ["So, the only dif­fer­ence with the pre­vi­ous ver­sion is ", _jsx(_components.code, {
        children: "config().getInteger(\"http.port\", 8080)"
      }), ". Here, our code is now re­quest­ing the con­fig­u­ra­tion and check whether the ", _jsx(_components.em, {
        children: "http.port"
      }), " prop­erty is set. If not, the port 8080 is used as fall-​back. The re­trieved con­fig­u­ra­tion is a ", _jsx(_components.code, {
        children: "JsonObject"
      }), "."]
    }), "\n", _jsx(_components.p, {
      children: "As we are using the port 8080 by de­fault, you can still pack­age our ap­pli­ca­tion and run it as be­fore:"
    }), "\n", _jsx(_components.pre, {
      children: _jsx(_components.code, {
        className: "hljs language-bash",
        children: "mvn clean package\njava -jar target/my-first-app-1.0-SNAPSHOT-fat.jar\n"
      })
    }), "\n", _jsx(_components.p, {
      children: "Sim­ple right ?"
    }), "\n", _jsxs(_components.h2, {
      id: "api-based-configuration---random-port-for-the-tests",
      children: [_jsx(_components.a, {
        "aria-hidden": true,
        tabIndex: "-1",
        className: "heading-anchor",
        href: "#api-based-configuration---random-port-for-the-tests"
      }), "API-based configuration - Random port for the tests"]
    }), "\n", _jsx(_components.p, {
      children: "Now that the ap­pli­ca­tion is con­fig­urable, let’s try to pro­vide a con­fig­u­ra­tion. In our test, we are going to con­fig­ure our ap­pli­ca­tion to use the port 8081. So, pre­vi­ously we were de­ploy­ing our ver­ti­cle with:"
    }), "\n", _jsx(_components.pre, {
      children: _jsx(_components.code, {
        className: "hljs language-java",
        children: "vertx.deployVerticle(MyFirstVerticle.class.getName(), context.asyncAssertSuccess());\n"
      })
    }), "\n", _jsxs(_components.p, {
      children: ["Let’s now pass some ", _jsx(_components.em, {
        children: "de­ploy­ment op­tions"
      }), ":"]
    }), "\n", _jsx(_components.pre, {
      children: _jsxs(_components.code, {
        className: "hljs language-java",
        children: ["port = ", _jsx(_components.span, {
          className: "hljs-number",
          children: "8081"
        }), ";\n", _jsx(_components.span, {
          className: "hljs-type",
          children: "DeploymentOptions"
        }), " ", _jsx(_components.span, {
          className: "hljs-variable",
          children: "options"
        }), " ", _jsx(_components.span, {
          className: "hljs-operator",
          children: "="
        }), " ", _jsx(_components.span, {
          className: "hljs-keyword",
          children: "new"
        }), " ", _jsx(_components.span, {
          className: "hljs-title class_",
          children: "DeploymentOptions"
        }), "()\n    .setConfig(", _jsx(_components.span, {
          className: "hljs-keyword",
          children: "new"
        }), " ", _jsx(_components.span, {
          className: "hljs-title class_",
          children: "JsonObject"
        }), "().put(", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"http.port\""
        }), ", port));\nvertx.deployVerticle(MyFirstVerticle.class.getName(), options, context.asyncAssertSuccess());\n"]
      })
    }), "\n", _jsxs(_components.p, {
      children: ["The ", _jsx(_components.code, {
        children: "DeploymentOptions"
      }), " ob­ject lets us cus­tomize var­i­ous pa­ra­me­ters. In par­tic­u­lar, it lets us in­ject the ", _jsx(_components.code, {
        children: "JsonObject"
      }), " re­trieved by the ver­ti­cle when using the ", _jsx(_components.code, {
        children: "config()"
      }), " method."]
    }), "\n", _jsxs(_components.p, {
      children: ["Ob­vi­ously, the test con­nect­ing to the server needs to be slightly mod­i­fied to use the right port (", _jsx(_components.code, {
        children: "port"
      }), " is a field):"]
    }), "\n", _jsx(_components.pre, {
      children: _jsxs(_components.code, {
        className: "hljs language-java",
        children: ["vertx.createHttpClient().getNow(port, ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"localhost\""
        }), ", ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"/\""
        }), ", response -> {\n  response.handler(body -> {\n    context.assertTrue(body.toString().contains(", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"Hello\""
        }), "));\n    async.complete();\n  });\n});\n"]
      })
    }), "\n", _jsx(_components.p, {
      children: "Ok, well, this does not re­ally fix our issue. What hap­pens when the port 8081 is used too. Let’s now pick a ran­dom port:"
    }), "\n", _jsx(_components.pre, {
      children: _jsxs(_components.code, {
        className: "hljs language-java",
        children: [_jsx(_components.span, {
          className: "hljs-type",
          children: "ServerSocket"
        }), " ", _jsx(_components.span, {
          className: "hljs-variable",
          children: "socket"
        }), " ", _jsx(_components.span, {
          className: "hljs-operator",
          children: "="
        }), " ", _jsx(_components.span, {
          className: "hljs-keyword",
          children: "new"
        }), " ", _jsx(_components.span, {
          className: "hljs-title class_",
          children: "ServerSocket"
        }), "(", _jsx(_components.span, {
          className: "hljs-number",
          children: "0"
        }), ");\nport = socket.getLocalPort();\nsocket.close();\n\n", _jsx(_components.span, {
          className: "hljs-type",
          children: "DeploymentOptions"
        }), " ", _jsx(_components.span, {
          className: "hljs-variable",
          children: "options"
        }), " ", _jsx(_components.span, {
          className: "hljs-operator",
          children: "="
        }), " ", _jsx(_components.span, {
          className: "hljs-keyword",
          children: "new"
        }), " ", _jsx(_components.span, {
          className: "hljs-title class_",
          children: "DeploymentOptions"
        }), "()\n    .setConfig(", _jsx(_components.span, {
          className: "hljs-keyword",
          children: "new"
        }), " ", _jsx(_components.span, {
          className: "hljs-title class_",
          children: "JsonObject"
        }), "().put(", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"http.port\""
        }), ", port));\n\nvertx.deployVerticle(MyFirstVerticle.class.getName(), options, context.asyncAssertSuccess());\n"]
      })
    }), "\n", _jsxs(_components.p, {
      children: ["So, the idea is very sim­ple. We open a ", _jsx(_components.em, {
        children: "server socket"
      }), " that would pick a ran­dom port (that’s why we put 0 as pa­ra­me­ter). We re­trieve the used port and close the socket. Be aware that this method is ", _jsx(_components.strong, {
        children: "not"
      }), " per­fect and may fail if the picked port be­comes used be­tween the ", _jsx(_components.code, {
        children: "close"
      }), " method and the start of our HTTP server. How­ever, it would work fine in the very high ma­jor­ity of the case."]
    }), "\n", _jsx(_components.p, {
      children: "With this in place, our test is now using a ran­dom port. Ex­e­cute them with:"
    }), "\n", _jsx(_components.pre, {
      children: _jsxs(_components.code, {
        className: "hljs language-bash",
        children: ["mvn clean ", _jsx(_components.span, {
          className: "hljs-built_in",
          children: "test"
        }), "\n"]
      })
    }), "\n", _jsxs(_components.h2, {
      id: "external-configuration---lets-run-on-another-port",
      children: [_jsx(_components.a, {
        "aria-hidden": true,
        tabIndex: "-1",
        className: "heading-anchor",
        href: "#external-configuration---lets-run-on-another-port"
      }), "External configuration - Let’s run on another port"]
    }), "\n", _jsxs(_components.p, {
      children: ["Ok, well ran­dom port is not what we want in ", _jsx(_components.em, {
        children: "pro­duc­tion"
      }), ". Could you imag­ine the face of your pro­duc­tion team if you tell them that your ap­pli­ca­tion is pick­ing a ran­dom port. It can ac­tu­ally be funny, but we should never mess with the pro­duc­tion team."]
    }), "\n", _jsxs(_components.p, {
      children: ["So for the ac­tual ex­e­cu­tion of your ap­pli­ca­tion, let’s pass the con­fig­u­ra­tion in an ex­ter­nal file. The con­fig­u­ra­tion is stored in a ", _jsx(_components.em, {
        children: "json"
      }), " file."]
    }), "\n", _jsxs(_components.p, {
      children: ["Cre­ate the ", _jsx(_components.code, {
        children: "src/main/conf/my-application-conf.json"
      }), " with the fol­low­ing con­tent:"]
    }), "\n", _jsx(_components.pre, {
      children: _jsxs(_components.code, {
        className: "hljs language-javascript",
        children: ["{\n  ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"http.port\""
        }), " : ", _jsx(_components.span, {
          className: "hljs-number",
          children: "8082"
        }), "\n}\n"]
      })
    }), "\n", _jsx(_components.p, {
      children: "And now, to use this con­fig­u­ra­tion just launch your ap­pli­ca­tion with:"
    }), "\n", _jsx(_components.pre, {
      children: _jsx(_components.code, {
        className: "hljs language-bash",
        children: "java -jar target/my-first-app-1.0-SNAPSHOT-fat.jar -conf src/main/conf/my-application-conf.json\n"
      })
    }), "\n", _jsxs(_components.p, {
      children: ["Open a browser on ", _jsx(_components.a, {
        href: "http://localhost:8082",
        children: "http://lo­cal­host:8082"
      }), ", here it is !"]
    }), "\n", _jsxs(_components.p, {
      children: ["How does that work ? Re­mem­ber, our ", _jsx(_components.em, {
        children: "fat jar"
      }), " is using the ", _jsx(_components.code, {
        children: "Starter"
      }), " class (pro­vided by Vert.x) to launch our ap­pli­ca­tion. This class is read­ing the ", _jsx(_components.code, {
        children: "-conf"
      }), " pa­ra­me­ter and cre­ate the cor­re­spond­ing de­ploy­ment op­tions when de­ploy­ing our ver­ti­cle."]
    }), "\n", _jsxs(_components.h2, {
      id: "conclusion",
      children: [_jsx(_components.a, {
        "aria-hidden": true,
        tabIndex: "-1",
        className: "heading-anchor",
        href: "#conclusion"
      }), "Conclusion"]
    }), "\n", _jsxs(_components.p, {
      children: ["After hav­ing de­vel­oped your first Vert.x ap­pli­ca­tion, we have seen how this ap­pli­ca­tion is con­fig­urable, and this with­out adding any com­plex­ity to our ap­pli­ca­tion. ", _jsx(Link, {
        href: "/blog/some-rest-with-vert-x/",
        passHref: true,
        children: _jsx(_components.a, {
          href: "",
          children: "In the next post"
        })
      }), ", we are going to see how we can use vertx-​web to de­velop a small ap­pli­ca­tion serv­ing sta­tic pages and a REST API. A bit more fancy, but still very sim­ple."]
    }), "\n", _jsx(_components.p, {
      children: "Happy Cod­ing and & Stay Tuned!"
    })]
  });
}
function MDXContent(props = {}) {
  const {wrapper: MDXLayout} = props.components || ({});
  return MDXLayout ? _jsx(MDXLayout, Object.assign({}, props, {
    children: _jsx(_createMdxContent, props)
  })) : _createMdxContent(props);
}
return {
  default: MDXContent
};
function _missingMdxReference(id, component) {
  throw new Error("Expected " + (component ? "component" : "object") + " `" + id + "` to be defined: you likely forgot to import, pass, or provide it.");
}


Blog

Vert.x Application Configuration

Next post

Some Rest with Vert.x

Previous post

My first Vert.x 3 Application

Blog

Vert.x Application Configuration

Next post

Some Rest with Vert.x

Previous post

My first Vert.x 3 Application

Related posts

Unit and Integration Tests

Things to keep in mind concerning CSRF attacks

Combine vert.x and mongo to build a giant