SpringBoot2 系列往期回顾:


spring boot 对于工程代码结构并没有特殊的要求,正常来说是可以对代码结构进行任意布局的。但是呢,“约定大于配置”,如果想要按照 springboot 的默认套路来,肯定是需要遵守一些潜在的约定的。接下来这篇就介绍 springboot 提供的关于代码结构的 2点 最佳实践建议,主要参考:14. Structuring Your Code

1、避免使用 default 包

  没有 package 声明的类被认为是在 default 包中。通常不建议而且应该避免 default 包default 包对于使用 @ComponentScan@EntityScan@SpringBootApplication 注解的 Spring Boot 应用来说,可能会导致一些问题,因为每个 jar 中的每个类可能都会被读取(不指定扫描的 package 路径的话,spring boot 默认从这些有注解的类所属的 package 进行扫描,这里的 default 包变成了所有代码的根路径)。

  注:对于包命名,建议使用 Java 推荐的反向域名命名约定,例如:com.example.project,像 springboot 用的则是 org.springframework.boot

2、主类 ( main application class ) 放置在root package

  通常建议将主类( main application class ,含有 main 方法的类)放置在其他类之上的 根package (root package)下,而且 @SpringBootApplication 注解也通常声明在主类上,它隐式地为某些项定义了基本的“搜索包”(search package,默认的 scan 路径)。例如在写 JPA 应用时,有 @SpringBootApplication 注解的类所属的 package 将被用于搜索 @Entity ,还有 @Service 等等注解都会进行扫描。使用 root package 允许 component scan 只应用于你的工程,而不会扫描其他的 jar 包。换句话说,就是限定了 scan 的范围从本工程的 root packag 开始,不会对所有 jar 包进行全扫描。

  小技巧:如果不想使用 @SpringBootApplication,可以使用 @EnableAutoConfiguration 和 @ComponentScan 进行代替和指定 scan 哪些 package
  下面的例子演示了一个典型的 spring boot 应用的包布局结构:

com
+- example
+- myapplication
+- Application.java
|
+- customer
| +- Customer.java
| +- CustomerController.java
| +- CustomerService.java
| +- CustomerRepository.java
|
+- order
+- Order.java
+- OrderController.java
+- OrderService.java
+- OrderRepository.java

  这里 root package 是 com.example.myapplication, Application.java 中会有 main 函数,同时会有 @SpringBootApplication 注解,默认扫描 com.example.myapplication 下的所有相关注解,配上这个例子应该可以更好地理解上面的内容:

package com.example.myapplication;

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}

  以上便是入手使用 springboot 时关于工程代码结构方面比较推荐的2个最佳实践。

Spring Boot2(005):关于代码结构的更多相关文章

  1. Spring boot 梳理 - 代码结构(Main类的位置)

    Spring boot 对代码结构无特殊要求,但有个套最佳实践的推荐 不要使用没有包名的类.没有包名时,@ComponentScan, @EntityScan, or @SpringBootAppli ...

  2. Spring Boot2(四):使用Spring Boot多数据源实现读写分离

    前言 实际业务场景中,不可能只有一个库,所以就有了分库分表,多数据源的出现.实现了读写分离,主库负责增改删,从库负责查询.这篇文章将实现Spring Boot如何实现多数据源,动态数据源切换,读写分离 ...

  3. Spring Boot2 系列教程(二)创建 Spring Boot 项目的三种方式

    我最早是 2016 年底开始写 Spring Boot 相关的博客,当时使用的版本还是 1.4.x ,文章发表在 CSDN 上,阅读量最大的一篇有 43W+,如下图: 2017 年由于种种原因,就没有 ...

  4. 图书-技术-SpringBoot:《Spring Boot2 + Thymeleaf 企业应用实战》

    ylbtech-图书-技术-SpringBoot:<Spring Boot2 + Thymeleaf 企业应用实战> <Spring Boot 2+Thymeleaf企业应用实战&g ...

  5. Spring Boot2(007):关于Spring beans、依赖注入 和 @SpringBootApplication 注解

    一.关于Spring beans 和 依赖注入(Dependency Injection) spring boot 和 Spring 全家桶无缝衔接,开发过程中可以很轻松地使用 Spring 全家桶的 ...

  6. Spring Boot2(006):关于配置类(Configuration Classes)和配置(Configuration)

    一.配置类(Configuration Classes) Spring Boot 支持基于 xml 的配置,但更偏向于使用基于 Java 的配置,通常建议使用定义有 main 方法的主 @Config ...

  7. Spring Boot2.x 动态数据源配置

    原文链接: Spring Boot2.x 动态数据源配置 基于 Spring Boot 2.x.Spring Data JPA.druid.mysql 的动态数据源配置Demo,适合用于数据库的读写分 ...

  8. SpringBoot之整合Quartz调度框架-基于Spring Boot2.0.2版本

    1.项目基础 项目是基于Spring Boot2.x版本的 2.添加依赖 <!-- quartz依赖 --> <dependency> <groupId>org.s ...

  9. Spring Boot2.0使用Spring Security

     一.Spring Secutity简介     Spring 是一个非常流行和成功的 Java 应用开发框架.Spring Security 基于 Spring 框架,提供了一套 Web 应用安全性 ...

随机推荐

  1. 「CF126B」Password

    题目描述 给定一个字符串 \(S\),我们规定一个字符串 \(P\) 是可行解,\(P\) 需要满足: \(P\) 是 \(S\) 的前缀 \(P\) 是 \(S\) 的后缀 \(P\) 出现在 \( ...

  2. js 表格操作----添加删除

    js 表格操作----添加删除 书名:<input type="text" id="name"> 价格:<input type="t ...

  3. zabbix监控 -mysql数据库

    1.禁用安装防护[root@mysql213 ~]# vi /etc/selinux/config #关闭安装 SELINUX=disabled 2.授权zabbix监控账号 mysql -uroot ...

  4. pytorch深度学习神经网络实现手写字体识别

    利用平pytorch搭建简单的神经网络实现minist手写字体的识别,采用三层线性函数迭代运算,使得其具备一定的非线性转化与运算能力,其数学原理如下: 其具体实现代码如下所示:import torch ...

  5. 新闻网大数据实时分析可视化系统项目——9、Flume+HBase+Kafka集成与开发

    1.下载Flume源码并导入Idea开发工具 1)将apache-flume-1.7.0-src.tar.gz源码下载到本地解压 2)通过idea导入flume源码 打开idea开发工具,选择File ...

  6. ROS学习笔记1-引言

    该学习笔记参考ROS官方wiki的内容,见:http://wiki.ros.org/ROS/Introduction 什么是ROSROS的全称是Robot Operating System,即机器人操 ...

  7. 华为轮值CEO,富士康却坚持独裁,二者究竟有什么不一样?

    谈到深圳龙华的大企业,人们会很自然地想到华为和富士康,两家公司毗邻,有两个门仅仅隔着一条马路,都是世界500强,对国家,对社区的经济发展有着重要贡献,员工压力最大的时候,也都出现过自杀的情况,一个讲究 ...

  8. Python递归函数如何写?正确的Python递归函数用法!

    在函数内部,可以调用其他函数.如果一个函数在内部调用自身本身,这个函数就是递归函数.一.举个例子,我们来计算阶乘n! = 1 x 2 x 3 x … x n,用函数fact(n)表示,可以看出:fac ...

  9. centos7安装mariadb(mysql)

    centos7 默认可以yum -y install mariadb-server mariadb mariadb-client mariadb-devel 如果出现错误 GPG key retrie ...

  10. NO34 awk