spring-boot-vuejs

# spring-boot-vuejs > **If you´re a JavaMagazin / blog.codecentric.de / Softwerker reader**, consider switching to [vue-cli-v2-webpack-v3](https://github.com/jonashackt/spring-boot-vuejs/tree/vue-cli-v2-webpack-v3) A live deployment is available on Heroku: https://spring-boot-vuejs.herokuapp.com This project is used as example in a variety of articles & as eBook: [blog.codecentric.de/en/2018/04/spring-boot-vuejs](https://blog.codecentric.de/en/2018/04/spring-boot-vuejs) | [JavaMagazin 8.2018](https://jaxenter.de/ausgaben/java-magazin-8-18) | [entwickler.press shortcuts 229](https://www.amazon.com/Vue-js-f%C3%BCr-alle-Wissenswertes-Einsteiger-ebook/dp/B07HQF9VX4/ref=sr_1_1?ie=UTF8&qid=1538484852&sr=8-1&keywords=Vue-js-f%C3%BCr-alle-Wissenswertes-Einsteiger-ebook) | [softwerker Vol.12](https://info.codecentric.de/softwerker-vol-12) ## Upgrade procedure Get newest node & npm: ```shell brew upgrade node npm install -g npm@latest ``` Update vue-cli ```shell npm install -g @vue/cli ``` Update Vue components/plugins (see https://cli.vuejs.org/migrating-from-v3/#upgrade-all-plugins-at-once) ```shell vue upgrade ``` ## In Search of a new Web Frontend-Framework after 2 Years of absence... Well, I’m not a Frontend developer. I’m more like playing around with Spring Boot, Web- & Microservices & Docker, automating things with Ansible and Docker, Scaling things with Spring Cloud, Docker Compose, and Traefik... And the only GUIs I’m building are the "new JS framework in town"-app every two years... :) So the last one was Angular 1 - and it felt, as it was a good choice! I loved the coding experience and after a day of training, I felt able to write awesome Frontends... But now we’re 2 years later and I heard from afar, that there was a complete rewrite of Angular (2), a new kid in town from Facebook (React) and lots of ES201x stuff and dependency managers like bower and Co. So I’m now in the new 2-year-cycle of trying to cope up again - and so glad I found this article: https://medium.com/reverdev/why-we-moved-from-angular-2-to-vue-js-and-why-we-didnt-choose-react-ef807d9f4163 Key points are: * Angular 2 isn’t the way to go if you know version 1 (complete re-write, only with Typescript, loss of many of 1’s advantages, Angular 4 is coming) * React (facebookish problems (licence), need to choose btw. Redux & MObX, harder learning curve, slower coding speed) And the [introduction phrase](https://vuejs.org/v2/guide/index.html) sounds really great: > Vue (pronounced /vjuː/, like view) is a progressive framework for building user interfaces. Unlike other monolithic frameworks, Vue is designed from the ground up to be incrementally adoptable. The core library is focused on the view layer only and is very easy to pick up and integrate with other libraries or existing projects. On the other hand, Vue is also perfectly capable of powering sophisticated Single-Page Applications when used in combination with modern tooling and supporting libraries. So I think, it could be a good idea to invest a day or so into Vue.js. Let’s have a look here! ## Setup Vue.js & Spring Boot ### Prerequisites #### MacOSX ``` brew install node npm install -g @vue/cli ``` #### Linux ``` sudo apt update sudo apt install node npm install -g @vue/cli ``` #### Windows ``` choco install npm npm install -g @vue/cli ``` ## Project setup ``` spring-boot-vuejs ├─┬ backend → backend module with Spring Boot code │ ├── src │ └── pom.xml ├─┬ frontend → frontend module with Vue.js code │ ├── src │ └── pom.xml └── pom.xml → Maven parent pom managing both modules ``` ## Backend Go to https://start.spring.io/ and initialize a Spring Boot app with `Web` and `Actuator`. Place the zip’s contents in the backend folder. Customize pom to copy content from Frontend for serving it later with the embedded Tomcat: ``` … ``` ## Frontend Creating our `frontend` project is done by the slightly changed (we use `--no-git` here, because our parent project is already a git repository and otherwise vue CLI 3 would initialize an new one): ``` vue create frontend --no-git ``` see https://cli.vuejs.org/guide/ This will initialize a project skeleton for Vue.js in /frontend directory - it, therefore, asks some questions in the cli: __Do not__ choose the default preset with `default (babel, eslint)`, because we need some more plugins for our project here (choose the Plugins with the __space bar__): You can now also use the new `vue ui` command/feature to configure your project: If you want to learn more about installing Vue.js, head over to the docs: https://vuejs.org/v2/guide/installation.html ### Use frontend-maven-plugin to handle NPM, Node, Bower, Grunt, Gulp, Webpack and so on :) If you’re a backend dev like me, this Maven plugin here https://github.com/eirslett/frontend-maven-plugin is a great help for you - because, if you know Maven, that’s everything you need! Just add this plugin to the frontend’s `pom.xml`: ``` … ``` ### Tell Webpack to output the dist/ contents to target/ Commonly, node projects will create a dist/ directory for builds which contains the minified source code of the web app - but we want it all in `/target`. Therefore we need to create the optional [vue.config.js](https://cli.vuejs.org/config/#vue-config-js) and configure the `outputDir` and `assetsDir` correctly: ```javascript module.exports = { ... // Change build paths to make them Maven compatible // see https://cli.vuejs.org/config/ outputDir;: 'target/dist', assetsDir;: 'static'; } ``` ## First App run Inside the root directory, do a: ``` mvn clean install ``` Run our complete Spring Boot App: ``` mvn --projects backend spring-boot:run ``` Now go to http://localhost:8098/ and have a look at your first Vue.js Spring Boot App. ## Faster feedback with webpack-dev-server The webpack-dev-server, which will update and build every change through all the parts of the JavaScript build-chain, is pre-configured in Vue.js out-of-the-box! So the only thing needed to get fast feedback development-cycle is to cd into `frontend` and run: ``` npm run serve ``` That’s it! ## Browser developer tools extension Install vue-devtools Browser extension https://github.com/vuejs/vue-devtools and get better feedback, e.g. in Chrome: ## IntelliJ integration There's a blog post: https://blog.jetbrains.com/webstorm/2018/01/working-with-vue-js-in-webstorm/ Especially the `New... Vue Component` looks quite cool :) ## HTTP calls from Vue.js to (Spring Boot) REST backend Prior to Vue 2.0, there was a build in solution (vue-resource). But from 2.0 on, 3rd party libraries are necessary. One of them is [Axios](https://github.com/mzabriskie/axios) - also see blog post https://alligator.io/vuejs/rest-api-axios/ ``` npm install axios --save ``` Calling a REST service with Axios is simple. Go into the script area of your component, e.g. Hello.vue and add: ```js import axios from 'axios' data ();{ return { response: [], errors: [] } }, callRestService ();{ axios.get(`api/hello`) .then(response => { // JSON responses are automatically parsed. this.response = response.data }) .catch(e => { this.errors.push(e) }) } } ``` In your template area you can now request a service call via calling `callRestService()` method and access `response` data: ```html CALL Spring Boot REST backend service

{{ response }}

``` ### The problem with SOP Single-Origin Policy (SOP) could be a problem if we want to develop our app. Because the webpack-dev-server runs on http://localhost:8080 and our Spring Boot REST backend on http://localhost:8098. We need to use Cross-Origin Resource Sharing Protocol (CORS) to handle that (read more background info about CORS here https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS) #### Enabling Axios CORS support Create a central Axios configuration file called `http-commons.js`: ```js import axios from 'axios' export const AXIOS = axios.create({ baseURL: `http://localhost:8098`, headers: { 'Access-Control-Allow-Origin': 'http://localhost:8080' } }) ``` Here we allow requests to the base URL of our Spring Boot App on port 8098 to be accessible from 8080. Now we could use this configuration inside our Components, e.g. in `Hello.vue`: ```js import {AXIOS} from './http-common' export default { name: 'hello', data () { return { posts: [], errors: [] } }, methods: { // Fetches posts when the component is created. callRestService () { AXIOS.get(`hello`) .then(response => { // JSON responses are automatically parsed. this.posts = response.data }) .catch(e => { this.errors.push(e) }) } } ``` #### Enabling Spring Boot CORS support Additionally, we need to configure our Spring Boot backend to answer with the appropriate CORS HTTP Headers in its responses (there's a good tutorial here: https://spring.io/guides/gs/rest-service-cors/). Therefore we add the annotation `@CrossOrigin` to our BackendController: ```java @CrossOrigin(origins = "http://localhost:8080") @RequestMapping(path = "/hello") public @ResponseBody String sayHello() { LOG.info("GET called on /hello resource"); return HELLO_TEXT; } ``` Now our Backend will respond CORS-enabled and will accept requests from 8080. But as this only enables CORS on one method, we have to repeatedly add this annotation to all of our REST endpoints, which isn’t a nice style. We should use a global solution to allow access with CORS enabled to all of our REST resources. This could be done in the `SpringBootVuejsApplication.class`: ```java // Enable CORS globally @Bean public WebMvcConfigurer corsConfigurer() { return new WebMvcConfigurerAdapter() { @Override public void addCorsMappings(CorsRegistry registry) { registry.addMapping("/api/*").allowedOrigins("http://localhost:8080"); } }; } ``` Now all calls to resources behind `api/` will return the correct CORS headers. #### But STOP! Webpack & Vue have something much smarter for us to help us with SOP! Thanks to my colleague [Daniel](https://www.codecentric.de/team/dre/) who pointed me to the nice proxying feature of Webpack dev-server, we don't need to configure all the complex CORS stuff anymore! According to the [Vue CLI 3 docs](https://cli.vuejs.org/config) the only thing we need to [configure is a devserver-proxy](https://cli.vuejs.org/config/#devserver-proxy) for our webpack devserver requests. This could be done easily in the optional [vue.config.js](https://cli.vuejs.org/config/#vue-config-js) inside `devServer.proxy`: ```js module.exports = { // proxy all webpack dev-server requests starting with /api // to our Spring Boot backend (localhost:8098) using http-proxy-middleware // see https://cli.vuejs.org/config/#devserver-proxy devServer: { proxy: { '/api': { target: 'http://localhost:8098', ws: true, changeOrigin: true } } }, ... } ``` With this configuration in place, the webpack dev-server uses the [http-proxy-middleware](https://github.com/chimurai/http-proxy-middleware), which is a really handy component, to proxy all frontend-requests from http://localhost:8080 --> http://localhost:8098 - incl. Changing the Origin accordingly. This is used in the webpack build process to configure the proxyMiddleware (you don't need to change something here!): ```js // proxy api requests Object.keys(proxyTable).forEach(function (context) { var options = proxyTable[context]; if (typeof options === 'string') { options = { target: options } } app.use(proxyMiddleware(options.filter || context, options)) }) ``` ## Using history mode for nicer URLs If we use the default configuration of the generated Vue.js template, we see URLs with a `#` inside them - like this: ```