新技术?
spring-boot并不是全新的技术栈,而是整合了spring的很多组件,并且以约定优先的原则进行组合。使用boot我们不需要对冗杂的配置文件进行管理,主需要用它的注解便可启用大部分web开发中所需要的功能。本篇就是基于boot来配置jpa和静态文件访问,进行web应用的开发。
模板or静态页面
最原始的jsp页面在springboot中已经不在默认支持,spring-boot默认使用thymeleaf最为模板。当然我们也可以使用freemark或者velocity等其他后端模板。但是按照前后端分离的良好设计,我们最好采用静态页面作为前端模板,这样前后端完全分离,把数据处理逻辑写在程序并提供接口供前端调用。这样的设计更加灵活和清晰。
项目搭建
我们将讨论项目的结构、application配置文件、静态页面处理、自定义filter,listener,servlet以及拦截器的使用。最后集中讨论jpa的配置和操作以及如何进行单元测试和打包部署。
项目结构
我们的HTML页面和资源文件都在resources/static下,打成jar包的时候static目录位于/BOOT-INF/classes/。
pom.xml
我们需要依赖下面这些包:
|
|
spring-boot-starter-parent使我们项目的父pom。
spring-boot-starter-web提供嵌入式tomcat容器,从而使项目可以通过打成jar包的方式直接运行。
spring-boot-starter-data-jpa引入了jpa的支持。
spring-boot-test和junit配合做单元测试。
mysql-connector-java和HikariCP做数据库的连接池的操作。
spring-boot-maven-plugin插件能把项目和依赖的jar包以及资源文件和页面一起打成一个可运行的jar(运行在内嵌的tomcat)
启动人口
|
|
这里ServletComponentScan注解是启用servlet3的servler和filter以及listener的支持,下面会提到该用法。要注意的是:不能引入@EnableWebMvc注解,否则需要重新配置视图和资源文件映射。这样就不符合我们的前后端分离的初衷了。
静态资源处理
spring-boot默认会去classpath下面的/static/,/public/ ,/resources/目录去读取静态资源。因此按照约定优先的原则,我们直接把我们应用的页面和资源文件直接放在/static下面,如下图所示:
这样我们访问系统主页就会自动加载index.html,而且它所引用的资源文件也会在static/下开始加载。
application.yml
我们在application配置文件中设置各种参数,它可以是传统的properties文件也可以使用yml来逐级配置。本文采用的第二种方式yml,如果不懂可以参考:https://baike.baidu.com/item/YAML/1067697?fr=aladdin。其内容如下:
|
|
使用idea开发工具在编辑器会有自动变量提示,这样非常方便进行参数的选择和查阅。
server
server节点可以配置容器的很多参数,比如:端口,访问路径、还有tomcat本身的一些参数。这里设置了session的超时以及编码等。
logging
日志级别可以定义到具体的哪个包路径,日志文件的配置要注意:path和file配置一个就行,file默认会在程序工作目录下生成,也可以置顶绝对路径进行指定。
datasource
这里使用号称性能最牛逼的连接池hikaricp,具体配置可以参阅其官网:http://brettwooldridge.github.io/HikariCP/
jpa
这里主要注意下strategy的配置,关系到自动建表时的字段命名规则。默认会生成带_划线分割entity的字段名(骆驼峰式)。
|
|
注册web组件
1) 最新的spring-boot引入新的注解ServletComponentScan,使用它可以方便的配置Servlet3+的web组件。主要有下面这三个注解:
|
|
只要把这些注解标记组件即可完成注册。
|
|
|
|
2) 拦截器的使用
拦截器不是Servlet规范的标准组件,它跟上面的三个组件不在一个处理链上。拦截器是spring使用AOP实现的,对controller执行前后可以进行干预,直接结束请求处理。而且拦截器只能对流经dispatcherServlet处理的请求才生效,静态资源就不会被拦截。
下面顶一个拦截器:
|
|
要想它生效则需要加入拦截器栈:
|
|
jpa操作
spring-boot已经集成了JPA的Repository封装,基于注解的事务处理等,我们只要按照常规的JPA使用方法即可。以Node表的操作为例:
- 定义entity
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
package gxf.dev.topology.entity; import com.fasterxml.jackson.annotation.JsonInclude; import javax.persistence.Entity; import javax.persistence.Id; import javax.persistence.Table; import java.io.Serializable; /** * Created by gongxufan on 2014/11/20. */ @Entity @Table(name ="node") @JsonInclude(JsonInclude.Include.NON_NULL) public class Node implements Serializable { @Id private String id; private String elementType; private String x; private String y; private String width; private String height; private String alpha; private String rotate; private String scaleX; private String scaleY; private String strokeColor; private String fillColor; private String shadowColor; private String shadowOffsetX; private String shadowOffsetY; private String zIndex; private String text; private String font; private String fontColor; private String textPosition; private String textOffsetX; private String textOffsetY; private String borderRadius; private String deviceId; private String dataType; private String borderColor; private String offsetGap; private String childNodes; private String nodeImage; private String templateId; private String deviceA; private String deviceZ; private String lineType; private String direction; private String vmInstanceId; private String displayName; private String vmid; private String topoLevel; private String parentLevel; private Setring nextLevel; //getter&setter }
JsonInclude注解用于返回JOSN字符串是忽略为空的字段。
编写repository接口
1 2 3 4 5 6 7
package gxf.dev.topology.repository; import gxf.dev.topology.entity.Node; import org.springframework.data.repository.PagingAndSortingRepository; public interface NodeRepository extends PagingAndSortingRepository<Node, String> { }
编写Service
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
package gxf.dev.topology.service; import gxf.dev.topology.entity.Node; import gxf.dev.topology.repository.NodeRepository; import gxf.dev.topology.repository.SceneRepository; import gxf.dev.topology.repository.StageRepository; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; import org.springframework.transaction.annotation.Transactional; /** * dao操作 * author:gongxufan * date:11/13/17 **/ @Component public class TopologyService { @Autowired private NodeRepository nodeRepository; @Autowired private SceneRepository sceneRepository; @Autowired private StageRepository stageRepository; @Transactional public Node saveNode(Node node) {return nodeRepository.save(node); } public Iterable<Node> getAll() { return nodeRepository.findAll(); } }
单元测试
单元测试使用spring-boot-test和junit进行,需要用到下面的几个注解:
|
|
测试代码如下:
|
|
jpa补充
使用JPA进行单表操作确实很方便,但是对于多表连接的复杂查询可能不太方便。一般有两种方式弥补这个不足:
- 一个是在Query里标注为NativeQuery,直接使用原生SQL。不过这种方式在动态参数查询到额情况下很不方便,这时候我们需要按条件拼接SQL。
- 自定义DAO
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
package gxf.dev.topology.repository; import com.mysql.jdbc.StringUtils; import org.hibernate.SQLQuery; import org.hibernate.criterion.CriteriaSpecification; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; import javax.persistence.EntityManager; import javax.persistence.EntityManagerFactory; import javax.persistence.Query; import java.math.BigDecimal; import java.util.ArrayList; import java.util.List; import java.util.Map; import java.util.regex.Matcher; import java.util.regex.Pattern; /** * 支持自定义SQL查询 * Created by gongxufan on 2016/3/17. */ @Component public class CustomSqlDao { @Autowired private EntityManagerFactory entityManagerFactory; public int getMaxColumn(final String filedName, final String tableName) { String sql ="select nvl(max(" + filedName + "), 0) as max_num from " + tableName; Map map = entityManagerFactory.getProperties(); String dialect = (String) map.get("hibernate.dialect"); //determine which database use if(!StringUtils.isNullOrEmpty(dialect)){ if(dialect.contains("MySQL")){ sql = "select ifnull(max(" + filedName + "), 0) as max_num from " + tableName; } if(dialect.contains("Oracle")){ sql = "select nvl(max(" + filedName + "), 0) as max_num from " + tableName; } } int maxID = 0; List<Map<String, Object>> list = this.querySqlObjects(sql); if (list.size() > 0) { Object maxNum = list.get(0).get("max_num"); if(maxNum instanceof Number) maxID = ((Number)maxNum).intValue(); if(maxNum instanceof String) maxID = Integer.valueOf((String)maxNum); } return maxID + 1; } public List<Map<String, Object>> querySqlObjects(String sql, Integer currentPage, Integer rowsInPage) { return this.querySqlObjects(sql, null, currentPage, rowsInPage); } public List<Map<String, Object>> querySqlObjects(String sql) { return this.querySqlObjects(sql, null, null, null); } public List<Map<String, Object>> querySqlObjects(String sql, Map params) { return this.querySqlObjects(sql, params, null, null); } @SuppressWarnings("unchecked") public List<Map<String, Object>> querySqlObjects(String sql, Object params, Integer currentPage, Integer rowsInPage) { EntityManager entityManager = entityManagerFactory.createEntityManager(); Query qry = entityManager.createNativeQuery(sql); SQLQuery s = qry.unwrap(SQLQuery.class); //设置参数 if (params != null) { if (params instanceof List) { List<Object> paramList = (List<Object>) params; for (int i = 0, size = paramList.size(); i < size; i++) { qry.setParameter(i + 1, paramList.get(i)); } } else if (params instanceof Map) { Map<String, Object> paramMap = (Map<String, Object>) params; Object o = null; for (String key : paramMap.keySet()) { o = paramMap.get(key); if (o != null) qry.setParameter(key, o); } } } if (currentPage != null && rowsInPage != null) {//判断是否有分页 // 起始对象位置 qry.setFirstResult(rowsInPage * (currentPage - 1)); // 查询对象个数 qry.setMaxResults(rowsInPage); } s.setResultTransformer(CriteriaSpecification.ALIAS_TO_ENTITY_MAP); List<Map<String, Object>> resultList = new ArrayList<Map<String, Object>>(); try { List list = qry.getResultList(); resultList = s.list(); } catch (Exception e) { e.printStackTrace(); } finally { entityManager.close(); } return resultList; } public int getCount(String sql) { String sqlCount = "select count(0) as count_num from " + sql; List<Map<String, Object>> list = this.querySqlObjects(sqlCount); if (list.size() > 0) { int countNum = ((BigDecimal) list.get(0).get("COUNT_NUM")).intValue(); return countNum; } else { return 0; } } /** * 处理sql语句 * * @param _strSql * @return */ public String toSql(String _strSql) { String strNewSql = _strSql; if (strNewSql != null) { strNewSql = regReplace("'", "''", strNewSql); } else { strNewSql = ""; } return strNewSql; } private String regReplace(String strFind, String strReplacement, String strOld) { String strNew = strOld; Pattern p = null; Matcher m = null; try { p = Pattern.compile(strFind); m = p.matcher(strOld); strNew = m.replaceAll(strReplacement); } catch (Exception e) { } return strNew; } /** * 根据hql语句查询数据 * * @param hql * @return */ @SuppressWarnings("rawtypes") public List queryForList(String hql, List<Object> params) { EntityManager entityManager = entityManagerFactory.createEntityManager(); Query query = entityManager.createQuery(hql); List list = null; try { if (params != null && !params.isEmpty()) { for (int i = 0, size = params.size(); i < size; i++) { query.setParameter(i + 1, params.get(i)); } } list = query.getResultList(); } catch (Exception e) { e.printStackTrace(); } finally { entityManager.close(); } return list; } @SuppressWarnings("rawtypes") public List queryByMapParams(String hql, Map<String, Object> params, Integer currentPage, Integer pageSize) { EntityManager entityManager = entityManagerFactory.createEntityManager(); Query query = entityManager.createQuery(hql); List list = null; try { if (params != null && !params.isEmpty()) { for (Map.Entry<String, Object> entry : params.entrySet()) { query.setParameter(entry.getKey(), entry.getValue()); } } if (currentPage != null && pageSize != null) { query.setFirstResult((currentPage - 1) * pageSize); query.setMaxResults(pageSize); } list = query.getResultList(); } catch (Exception e) { e.printStackTrace(); } finally { entityManager.close(); } return list; } @SuppressWarnings("rawtypes") public List queryByMapParams(String hql, Map<String, Object> params) { return queryByMapParams(hql, params, null, null); } @SuppressWarnings("rawtypes") public List queryForList(String hql) { return queryForList(hql, null); } /** * 查询总数 * * @param hql * @param params * @return */ public Long queryCount(String hql, Map<String, Object> params) { EntityManager entityManager = entityManagerFactory.createEntityManager(); Query query = entityManager.createQuery(hql); Long count = null; try { if (params != null && !params.isEmpty()) { for (Map.Entry<String, Object> entry : params.entrySet()) { query.setParameter(entry.getKey(), entry.getValue()); } } count = (Long) query.getSingleResult(); } catch (Exception e) { e.printStackTrace(); } finally { entityManager.close(); } return count; } /** * 查询总数 * * @param sql * @param params * @return */ public Integer queryCountBySql(String sql, Map<String, Object> params) { EntityManager entityManager = entityManagerFactory.createEntityManager(); Integer count = null; try { Query query = entityManager.createNativeQuery(sql); if (params != null && !params.isEmpty()) { for (Map.Entry<String, Object> entry : params.entrySet()) { query.setParameter(entry.getKey(), entry.getValue()); } } Object obj = query.getSingleResult(); if (obj instanceof BigDecimal) { count = ((BigDecimal) obj).intValue(); } else { count = (Integer) obj; } } finally { if (entityManager != null) { entityManager.close(); } } return count; } /** * select count(*) from table * * @param sql * @param params * @return */ public int executeSql(String sql, List<Object> params) { EntityManager entityManager = entityManagerFactory.createEntityManager(); try { Query query = entityManager.createNativeQuery(sql); if (params != null && !params.isEmpty()) { for (int i = 0, size = params.size(); i < size; i++) { query.setParameter(i + 1, params.get(i)); } } return query.executeUpdate(); } finally { if (entityManager != null) { entityManager.close(); } } } }
我们在service层注入,然后就可以根据输入条件拼接好sql或者hql来进行各种操作。这种方式灵活而且也不需要手动写分页代码,使用hibernate封装好的机制即可。
总结
使用boot可以快速搭建一个前后端开发的骨架,里面有很多自动的配置和约定。虽然boot不是新的一个技术栈,但是它要求我们对各个组件都要比较熟悉,不然对它的运行机制和约定配置会感到很困惑。而使用JPA进行数据库操作也是利弊参半,需要自己权衡。