[jboss-user] [JBoss Tools] - New Hibernate Tools features in JBDS 6

Jiri Peterka [https://community.jboss.org/people/jpeterka] modified the document: "New Hibernate Tools features in JBDS 6" To view the document, visit: https://community.jboss.org/docs/DOC-48444 -------------------------------------------------------------- h1. New Hibernate tool features in JBDS 6 This article will show you some of new features and enhancements in Hibernate Tools 3.6.0 which is part of JBoss Tools 4.0.0 and also JBoss Developer Studio 6.0.0 (further referred as JBDS). We shall partially meet this areas of Hibernate tools in this tutorial: * JBoss Hibernate tools libraries for code generation with ANT tasks support * New database profile connection features for Hibernate * Some new Hibernate features in JPA projects h2. Prerequisites JBoss Developer Studio It’s expected you have JDK 1.6 or higher and JBDS 6.0.0.GA that you can download from https://devstudio.jboss.com/earlyaccess/6.0.0.GA.html https://devstudio.jboss.com/earlyaccess/6.0.0.GA.html and to install is simply using following command: java -jar jbdevstudio-product-universal-6.0.0.GA-v20121206-1855-B186.jar Go through installer wizard and after it’s finish start JBoss Developer Studio, select new workspace location and you should see a screen below . https://lh6.googleusercontent.com/9y16idOz_-IPfChs59bIzoA8SrOy_yh55SwBWua... https://lh6.googleusercontent.com/9y16idOz_-IPfChs59bIzoA8SrOy_yh55SwBWua... Click on “Get started with JBoss Central” and your IDE is ready for you. h3. Database Outside IDE download and start database needed for this tutorial. We will use sakila database running on h2 database. Follow these steps: mkdir ~/db cd db git://github.com/maxandersen/sakila-h2.git ./sakila-h2/runh2.sh You should see a database started https://lh6.googleusercontent.com/Hw3EV7J7nHaciFPdfn7b5oudUpACIyARBAWbKG-... https://lh6.googleusercontent.com/Hw3EV7J7nHaciFPdfn7b5oudUpACIyARBAWbKG-... Go back to IDE and check the database. Switch to “Database Development” perspective. And define database connection. In “Data Source Explorer” view define new connection by context menu. Select Generic JDBC Driver (because there is not specific profile for h2) https://lh6.googleusercontent.com/y0iWJEdGmdLO1aH2mNer-Ck9v7lJhlun2F5ppLo... https://lh6.googleusercontent.com/y0iWJEdGmdLO1aH2mNer-Ck9v7lJhlun2F5ppLo... Switch  to “JAR List” tab and add h2-<version>.jar from h2 where you have installed it. Then go to properties and add jdbc connection as written by started sakila db server. Update drive class (you can use auto lookup feature if you want). https://lh3.googleusercontent.com/p_jkbXQmCQpEu0sAHAhulV8IhTb91yxwx4syl0C... https://lh3.googleusercontent.com/p_jkbXQmCQpEu0sAHAhulV8IhTb91yxwx4syl0C... Now you can test connection by clicking “Test Connection button” https://lh5.googleusercontent.com/j9pr-eVRTqrhDCfbgSuYK0PX99iPGtbiI6QJABu... https://lh5.googleusercontent.com/j9pr-eVRTqrhDCfbgSuYK0PX99iPGtbiI6QJABu... h2. You should see “Ping succeeded!” message box. After it’s closing, just just click Finish. Now you can browse database structure and can see database content if you want. https://lh4.googleusercontent.com/nt4e84GBv2OO4XuSUgOEsvHz3NWuFxX-JwxMe0n... https://lh4.googleusercontent.com/nt4e84GBv2OO4XuSUgOEsvHz3NWuFxX-JwxMe0n... Well, prerequisites are over so let’s take a look what hibernate tools provides. h2. NEW FEATURE: Hibernate tools libraries update One thing that was updated in JBDS 6 is Hibernate Tools for Ant. It was updated to these versions. * 3.4.0.CR2 for Hibernate 3.5 * 3.6.0.CR1 for Hibernate 3.6 * 4.0.0.CR1 for Hibernate 4 So let’s refresh our memory and try small tutorial how to use this feature in JBDS. We will create simple plug-in project and let UI to generate java db entities and also build.xml using hibernate-tools.jar ant tasks that can be modified and used further. Then we shall import ant file into our project, slightly update it and and execute it. Now create a testing project. In menu navigate: New -> Other … -> Plug-in project https://lh3.googleusercontent.com/snmZAUub5K6UFo5sKKBldEbTNCZOvqUtNeVH6po... https://lh3.googleusercontent.com/snmZAUub5K6UFo5sKKBldEbTNCZOvqUtNeVH6po... In wizard navigate: Next https://lh4.googleusercontent.com/m5EPpl2Bydw7QPb7XO6qJbGzREDt8ZSquDTu4zy... https://lh4.googleusercontent.com/m5EPpl2Bydw7QPb7XO6qJbGzREDt8ZSquDTu4zy... In wizard navigate: Next, Finish. Nice, your project is created. You can also create Java Project or any other type either  mavenized or Eclipse type project. Additional steps would be only slightly different. We created eclipse plug-in project so we can easily add dependencies via manifest file. Now open MANIFEST.MF in Package Explorer to add hibernate-tools into our project. https://lh5.googleusercontent.com/DedhkVJeb-F7sScMpctDwVx_i-Re3bSnWyX2Sw-... https://lh5.googleusercontent.com/DedhkVJeb-F7sScMpctDwVx_i-Re3bSnWyX2Sw-... Switch to “Dependencies” tab click “Add...” button and start type “org.jboss.tools.hibernate” and select “org.jboss.tools.hibernate4_0” which adds hibernate libraries to our project (and mainly desired hibernate-tools.jar for Hibernate 4.0. https://lh6.googleusercontent.com/s6HcHQIgo5NxeO2dBNPk-qyARc1jBpCB28m83Zw... https://lh6.googleusercontent.com/s6HcHQIgo5NxeO2dBNPk-qyARc1jBpCB28m83Zw... When hibernate plugin is added into your MANIFEST.MF, you can save and close the editor. Let’s create hibernate configuration. In menu navigate to: New -> Other … -> Hibernate Configuration File (cfg.xml). Click Next, select src folder and click Next https://lh4.googleusercontent.com/WxC_TtmF3jLxsPAt2MxzF5JL6vxTCdohCS_GgSW... https://lh4.googleusercontent.com/WxC_TtmF3jLxsPAt2MxzF5JL6vxTCdohCS_GgSW... NEW FEATURE: Connection profile can be used for hibernate configuration settings One of new features is “Get values from connection”. Since we’ve already created database connection profile we can use it. https://lh6.googleusercontent.com/RNn0jiRNmWcDgDug1aJmNbMfR03MROV0Gzqe4tM... https://lh6.googleusercontent.com/RNn0jiRNmWcDgDug1aJmNbMfR03MROV0Gzqe4tM... https://lh3.googleusercontent.com/ksHlLJumN5CF5oDxoRiwrjndxkG-vRqMwktc-do... https://lh3.googleusercontent.com/ksHlLJumN5CF5oDxoRiwrjndxkG-vRqMwktc-do... You can see the values were filled. We just need to add some additional properties like database dialect, etc. Check “Create a console configuration” and “Next”. Here just switch “Hibernate Version” to “4.0”. Click Finish. NEW FEATURE: Connection profile can be used for datasource connection settings It’s not part of this tutorial but similarly we can use this feature also while creating datasource file for application server like JBoss AS os EAP. To use it navigate to New -> Other... -> JBoss Datasource (-ds.xml). https://lh5.googleusercontent.com/o-3fjbCN1Ah-aArR9uS8tJ60p3Cvj-SvNgHNWbo... https://lh5.googleusercontent.com/o-3fjbCN1Ah-aArR9uS8tJ60p3Cvj-SvNgHNWbo... Ok, let’s continue with our example. Let’s try to generate some code from our database. Switch to “Hibernate” perspective if you already didn’t do that. Now navigate to Run -> Hibernate Code Generation -> Hibernate Code Generation Configurations...  You should see dialog similar to one below. Your configuration is already there so we can configure it a little bit and generate some code. Select your “Console configuration”, check “Reverse engineer from JDBC Connection” and add some package for exported entities.  Select also your project src as “Output directory:”. https://lh3.googleusercontent.com/GCJcd_4n74WmPl4Z4dPEGtn5MlpQpKspmM4tjwE... https://lh3.googleusercontent.com/GCJcd_4n74WmPl4Z4dPEGtn5MlpQpKspmM4tjwE... On “Exporters”  tab you can select Domain code or any other artefacts you want to generate (note that some of them requires additional configuration). https://lh4.googleusercontent.com/jMT2x8GNex6g5wrF_y2SWAdLN-hY2lBBxNLvN71... https://lh4.googleusercontent.com/jMT2x8GNex6g5wrF_y2SWAdLN-hY2lBBxNLvN71... When you click “Run” your code will be generated. There are many other possibilities how to tweak your exports (like reveng files, etc.) but it’s beyond this tutorial.  Anyway you have exported entities. https://lh6.googleusercontent.com/Y95LxhoU9diaA9XE-sKBU1bKbk90hEW6YvNcxYo... https://lh6.googleusercontent.com/Y95LxhoU9diaA9XE-sKBU1bKbk90hEW6YvNcxYo... During code generation there was some “magic” done. Let’s see what happened. This export we’ve just made is done by hibernate-tools.jar ant task which is used in generated build.xml. Let’s see if we can take a look at this ant file. So now try get the ant file. Click On project, invoke context menu and select “Export” -> “Hibernate” -> “Ant Code Generation” https://lh5.googleusercontent.com/qQqPmOZuV3621uS-d7MwlRZ8LIeg3wbr0dJswlW... https://lh5.googleusercontent.com/qQqPmOZuV3621uS-d7MwlRZ8LIeg3wbr0dJswlW... Select Hibernate configuration, select project, fill in the “File name:” to export and click Finish. https://lh6.googleusercontent.com/9fL3xfB_ty3SYcjXvEce6A_fMT98k1QM1vqO6EN... https://lh6.googleusercontent.com/9fL3xfB_ty3SYcjXvEce6A_fMT98k1QM1vqO6EN... We we successful, build.xml is available in our plug-in project. We can see HibernateToolTask target which is executes <hbm2java> task. https://lh6.googleusercontent.com/V7uIDxTPmX2zDNRmMZttwn3rU9IvglZOXh1R1cz... https://lh6.googleusercontent.com/V7uIDxTPmX2zDNRmMZttwn3rU9IvglZOXh1R1cz... You can now use and customize ant xml file to achieve your specific goals by adding and modifying ant tasks and of course you can use code completion. Not that you can use it for generating different types of hibernate configuration, for various export types and definition and more.  And of course this script works also outside an IDE. For more details see a https://access.redhat.com/knowledge/docs/en-US/JBoss_Developer_Studio/6.0... documentation. Not let’s take a shortly look on some other features that are available. NEW FEATURE: Persistence.xml is update with connection profile information automatically As the title refers you don’t have to add connection informations into persistence.xml manually.  You can see it for yourself. Just Create “New JPA Project” (again New -> Others... -> JPA Project) https://lh5.googleusercontent.com/gKgJ8AmiGcaAv3yX-ZQ_Zyufr8DvhabPdbRNzck... https://lh5.googleusercontent.com/gKgJ8AmiGcaAv3yX-ZQ_Zyufr8DvhabPdbRNzck... Fill in basic properties like “Project name”. https://lh5.googleusercontent.com/xK5tluIA9T-VPOpEpyHGnkZDA82C6i1mArLOddD... https://lh5.googleusercontent.com/xK5tluIA9T-VPOpEpyHGnkZDA82C6i1mArLOddD... Select “Hibernate (JPA 2.x)” platform and set connection to a connection you’ve created before. https://lh4.googleusercontent.com/9eCBDt0Fw-2AFLS3Bbs_Beg12QA9iSpKzGWsGOq... https://lh4.googleusercontent.com/9eCBDt0Fw-2AFLS3Bbs_Beg12QA9iSpKzGWsGOq... And click Finish. When you open persistence.xml, you can see your connection is properly configured. https://lh3.googleusercontent.com/ta--ERrdFssKUolw7aCOOVw7AbIi9Pe6MoBKK6C... https://lh3.googleusercontent.com/ta--ERrdFssKUolw7aCOOVw7AbIi9Pe6MoBKK6C... Let’s see another features. We will use a project created before. NEW FEATURE: Persistence.xml is update with connection profile information automatically Before continuing add Hibernate libraries to JPA Project (you can use libraries available in JBDS in from plugins/org.jboss.tools.hibernate4_.... /lib/required). Without this feature will not work. Select JPA project and from context menu use “JPA Tools -> Generate Entities from tables”. Set basic parameters like what package should be used for entities generation and correct hibernate configuration. Click Finish. https://lh5.googleusercontent.com/WHmxN1LGfxnpO92hUrvW91jINMemiCEG-nGTFUn... https://lh5.googleusercontent.com/WHmxN1LGfxnpO92hUrvW91jINMemiCEG-nGTFUn... When you check persistence.xml, JBDS updated your persistence.xml accordingly with new entities. If your persistence.xml is opened during code generation you can see it live. https://lh3.googleusercontent.com/7wBWkVsEXVEeaWabGjIe7bLCNu88X2XDTm2aveh... https://lh3.googleusercontent.com/7wBWkVsEXVEeaWabGjIe7bLCNu88X2XDTm2aveh... There are many others Hibernate features available in latest stable Hibernate Tools that is available within JBoss Tools or JBoss Developer Studio. You can see all Hibernate tools features for JBDS 6.0.0 https://issues.jboss.org/issues/?filter=12318813 here. That’s all, enjoy latest Hibernate Tools! If you have any comment please share it below. -------------------------------------------------------------- Comment by going to Community [https://community.jboss.org/docs/DOC-48444] Create a new document in JBoss Tools at Community [https://community.jboss.org/choose-container!input.jspa?contentType=102&a...]