IDEA下从零开始搭建SpringBoot工程的方法步骤
springboot的具体介绍可以参看其他网上介绍,这里就不多说了,就这几天的学习,个人理解,简而言之:
(1)它是spring的升级版,spring容器能做到的事情,它都能做到,而且更简便,从配置形式上来说,springboot完全抛弃了繁琐的xml文件配置方式,而是替代性地用注解方式来实现,虽然本质来说,是差不多的(类似包扫描,注解扫描,类加载之类)。
(2)springboot集成的插件更多,从而使用很多服务,都只是引入一个依赖,几个注解和java类就可以用了,具体的参考相关手册。
(3)在web应用开发这一块,之前的应用一般来说是打包成war包,再发布到相关服务器容器下(例如tomcat),虽然springboot也可以这么做,但在springboot下更常见的形式是将springboot应用打包成可执行jar包文件。之所以这么做,源于你可以直接将springboot应用看成是一个java application,其web应用可以没有webapp目录(更不用说web.xml了),它推荐使用html页面,并将其作为静态资源使用。
下面具体记录一下,如何在idea下从零开始,一步步搭建springboot web应用,这里采用的是maven作依赖管理,新手起步,有任何疑问,请参考springboot官网。
需要说明的是springboot依赖的jdk版本为1.8及以上。
(1)file->new,选择maven,创建一个空项目,直接next.
(2)填写工程名
(3)next到底,成果创建一个基于maven的空java项目,其目录结构是这样的:
(4)在pom文件中引入springboot相关依赖
<parent> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-parent</artifactid> <version>1.5.1.release</version> </parent> <dependencies> <dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-web</artifactid> </dependency> </dependencies>
(5)新建一个controller 包,用于存放所有的controller,这里跟官方的一样,使用samplecontroller为第一个测试用例。代码如下:
/** * created by song on 2017/2/15. * 官方示例工程中的测试代码 */ @controller @enableautoconfiguration public class samplecontroller { @requestmapping("/") @responsebody string home() { return "hello world!"; } public static void main(string[] args) throws exception { springapplication.run(samplecontroller.class, args); } }
注意到,这里有一个main函数,再联想到前面说的,springboot应用一般是打包成可执行jar包来发布的,这个main函数就是整个项目的入口。而之所以能这么做,是因为springboot连tomcat8作为一个插件都集成进去了,所以就不必跟之前的ssm架构下一样,还需要去在tomcat下配置war包才能运行。直接点击运行该main函数,再浏览器链接栏,输入地址http://localhost:8080/,就可以看到打印的字符串”hello world!”了。这就是官网提供的一个最基本的基于springboot的web应用,如此便捷。
当然,一个基本的web应用,结构肯定不会这么简单。下面要说的是,如何在上面的基础上,搭建一个具有mvc结构的完整的web应用,其中数据库采用的是mysql,orm采用的是spring data jpa,前端页面采用js+html5。(当然还有其他的方式,例如orm框架采用mybatis等,本文暂未涉及。)
(6)在resource目录下新建一个application.properties文件(或yml文件),命名与位置为springboot默认的配置文件。在该文件中,记录着所有的模块配置内容。例如tomcat的端口(默认8080)以及编码方式等:
server.port=8080 server.tomcat.uri-encoding=utf-8
(7)引入本项目中所需要的相关依赖(mysql连接驱动 以及spring data jpa,thymeleaf模板引擎)
<!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java --> <dependency> <groupid>mysql</groupid> <artifactid>mysql-connector-java</artifactid> <version>5.1.39</version> </dependency> <!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-thymeleaf --> <dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-thymeleaf</artifactid> <version>1.4.0.release</version> </dependency> <!-- https://mvnrepository.com/artifact/org.springframework.data/spring-data-jpa --> <dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-data-jpa</artifactid> <version>1.5.1.release</version> </dependency>
(8)在application.properties中配置mysql数据库连接信息
这里的数据库为本地数据库test,用户名和密码改成自己的
#mysql spring.datasource.driver-class-name=com.mysql.jdbc.driver spring.datasource.url=jdbc:mysql://localhost:3306/test?characterencoding=utf8 spring.datasource.username=**** spring.datasource.password=****
(9)在application.properties中配置spring data jpa
这一段的意思就是说,数据库类型为mysql,日志信息打印具体执行的sql语句,表更新策略以及java类到数据库表字段的映射规则等,具体查看网络资料。
#spring data jpa spring.jpa.database=mysql spring.jpa.show-sql=true spring.jpa.hibernate.ddl-auto=update # naming strategy spring.jpa.hibernate.naming-strategy = org.hibernate.cfg.improvednamingstrategy # stripped before adding them to the entity manager) spring.jpa.properties.hibernate.dialect = org.hibernate.dialect.mysql5dialect
(10)编写一个实体类user
@table标签,指定数据库中对应的表名,id配置为主键,生成策略为自动生成
/** * created by song on 2017/2/15. * model 用户 */ @entity @table(name = "tbl_user") public class user { @id @generatedvalue(strategy = generationtype.identity) private long id; private string name; private string password; }
(11)基于jpa,实现dao层(即数据库数据的增删改查操作)
新建userrepositoty.java接口文件,源代码如下:
/** * created by song on 2017/2/15. * user表操作接口 */ @repository public interface userrepositoty extends jparepository<user,long>{ @query("select t from user t where t.name = :name") user findbyusername(@param("name") string name); }
需要解释的是,spring data jpa提供了很多持久层接口,例如repository,crudrepositoty,pagingandsortingrepository 以及jparepository 接口。其中repository为基类,jparepository继承自pagingandsortingrepository接口,两个泛型参数分别代表java pojo类以及主键数据类型。我们创建自己的数据库操作接口时,只需继承上述jpa提供的某个接口,即可自动继承相关数据操作方法,而不需要再次实现。例如crudrepositoty提供了对增删改查操作的实现,pagingandsortingrepository提供了分页查询方法的实现。另外jpa提供了一套命名规则例如readby**()等,这些方法也只需要用户申明而由jpa自动实现了。如果这仍不能满足业务需求,也可以自定义sql查询语句,例如上述代码所示,采用@query标签, 其中 :*语法为引用下面用@param标识的变量,需要注意的是其中user不是表面而是java pojo类名。具体使用参考jpa使用手册。
(12)设计service层业务代码
新建userservice类,其源代码如下:
/** * created by song on 2017/2/15. * user业务逻辑 */ @service public class userservice { @autowired private userrepositoty userrepositoty; public user finduserbyname(string name){ user user = null; try{ user = userrepositoty.findbyusername(name); }catch (exception e){} return user; } }
(13)设计controller层
新建usercontroller.java,提供两个接口,/user/index 返回页面,/user/show返回数据。其源代码如下:
/** * created by song on 2017/2/15. * user控制层 */ @controller @requestmapping(value = "/user") public class usercontroller { @autowired private userservice userservice; @requestmapping(value = "/index") public string index(){ return "user/index"; } @requestmapping(value = "/show") @responsebody public string show(@requestparam(value = "name")string name){ user user = userservice.finduserbyname(name); if(null != user) return user.getid()+"/"+user.getname()+"/"+user.getpassword(); else return "null"; } }
(14)在application.properties文件中配置页面引擎。这里采用springmvc(springboot还提供thymeleaf,freemaker等)。这里需要配置其静态资源(js、css文件、图片文件等)路径,以及html页面文件路径,参考springmvc在spring下的配置。
#视图层控制 spring.mvc.view.prefix=classpath:/templates/ spring.mvc.view.suffix=.html spring.mvc.static-path-pattern=/static/**
(15)在resource目录下新建templates以及static目录,分别用于存放html文件以及(js、css文件、图片)文件。在(13)中返回了一个“user/index”页面,所以在templates下新建user目录,在user目录下新建index.html页面,这里就不写什么了,默认页面,通过相对路径引入js文件,js文件里只做示意,弹出一个alert()。
user/index.html
<!doctype html> <html lang="en"> <head> <meta charset="utf-8"/> <script src="../static/scripts/jquery.min.js"></script> <script src="../static/scripts/test.js"></script> <title>title</title> </head> <h1>test page</h1> <body> </body> </html> static/scripts/test.js $(document).ready(function (){ alert("ok test"); });
(16)配置jpa
新建一个configuration包,用于存放项目配置类。类似ssm架构下,spring需要配置java pojo类包路径以及dao层接口路径,以自动扫描相关注解,这里同样需要配置这两项,不同的是spring采取的是xml配置方式,这里用java代码+注解方式配置。新建一个jpaconfiguration.java类,其代码如下:
/** * created by song on 2017/2/15. * jpa 配置类 */ @order(ordered.highest_precedence) @configuration @enabletransactionmanagement(proxytargetclass = true) @enablejparepositories(basepackages = "com.song.repository") @entityscan(basepackages = "com.song.entity") public class jpaconfiguration { @bean persistenceexceptiontranslationpostprocessor persistenceexceptiontranslationpostprocessor(){ return new persistenceexceptiontranslationpostprocessor(); } }
(17)配置项目启动入口
到这一步就可以删掉(5)中官方示例给出的samplecontroller.java了,由于我们的工程结构已经发生了改变,我们需要告诉springboot框架去扫描哪些包从而加载对应类,所以这里重新编写main函数。新建一个entry.java类,其代码如下(其中@springbootapplication是一个复合注解,就理解为自动配置吧):
/** * created by song on 2017/2/15. * 项目启动入口,配置包根路径 */ @springbootapplication @componentscan(basepackages = "com.song") public class entry { public static void main(string[] args) throws exception { springapplication.run(entry.class, args); } }
(18)运行main函数,访问http://localhost:8080/user/index 会显示测试页面,并弹出alert(),访问http://localhost:8080/user/show?name=**(数据表里存在的数据)会显示user信息。最终的工程文件结构如下:
完整项目工程:https://github.com/sonlan/springboot-demo
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。
上一篇: JAVA设计模式之调停者模式详解