Spring 依赖注入实现示例
【注】本文译自:https://springframework.guru/...
在本文中,我将向你展示如何在SpringFramework的依赖项注入中使用ProjectLombok以获得最佳实践。
Spring框架本身具有多种执行依赖项注入的方式。选项的灵活性是Spring框架的优势。但是,并非所有的依赖项注入选项都被视为最佳实践。有些实际上不太好。
依赖注入示例
我提供了一些设置示例,供我们查看必须使用的各种依赖项注入选项。
让我们以SpringService为例。就我们的目的而言,该服务具有一种返回字符串的方法。我们将使用“service”,并使用Spring将其注入一些模拟控制器中。请记住,我们只是在探索如何使用SpringFramework进行依赖项注入。
示例Service
publicclassMyService{ publicStringgetHello(){ return"Hello"; } }
我们的Field拥有一项公有属性的服务。我们可以注解该字段,Spring将注入该服务的实例。
属性注入
FieldController
@Controller publicclassFieldController{ @Autowired MyServicemyService; publicStringsaySomething(){ returnmyService.getHello(); } }
这只是一个公有属性,没有setter。显然,这不是一个好的实践,不推荐这样做。
我们可以对此进行一些改进,将该字段的访问权限设为私有。SpringFramework确实允许你自动装配私有字段。你确实看到有人这样做。Spring将执行一些反射魔术来执行依赖项注入
私有FieldController
publicclassPrivateFieldController{ @Autowired privateMyServicemyService; publicStringsaySomething(){ returnmyService.getHello(); } }
尽管只使用私有字段比较好,但是测试却成了一个令人头痛。你要么需要启动SpringContext,要么使用一些Spring实用程序来执行依赖注入以进行测试。不是世界末日,但总的来说很烦人。
我们可以通过为私有属性提供setter来改善这一点。Getter和Setter通常被认为是面向对象编程中的最佳实践。通过注解setter方法,指示Spring使用setter进行依赖项注入很简单。
方法注入
SetterController
@Controller publicclassSetterController{ privateMyServicemyService; @Autowired publicvoidsetMyService(MyServicemyService){ this.myService=myService; } publicStringsaySomething(){ returnmyService.getHello(); } }
这是使用私有字段时的明显改进。有人会抱怨这要写太多代码。但是实际上,自SouthPark的第一季以来,此类任务已在现代IDE中实现了自动化。
构造函数注入
下一个选项是使用构造函数。到目前为止,这是我们研究过的最佳方法。使用构造函数设置注入的属性时,不必提供自动装配注释。这是一个很好的功能,可以节省一些键入时间。从SpringFramework版本4.2开始,用于依赖项注入的构造函数的注释是可选的。
ConstructorController
@Controller publicclassConstructorController{ privateMyServicemyService; publicConstructorController(MyServicemyService){ this.myService=myService; } publicStringsaySomething(){ returnmyService.getHello(); } }
基于构造函数的依赖注入无疑被认为是最佳实践。曾经有一段时间我个人偏爱基于setter的注入,但是后来又转向基于构造函数的注入。
我们仍然可以改善我们的示例。现在有两个主要问题。第一,我们的服务类型是具体类型。硬类型的依赖注入不是最佳实践。
第二个问题是,我们要注入的属性未声明为final。因此,从理论上讲,该类可以在实例化注入的属性后对其进行修改。依#赖注入最佳实践
依赖项注入的最佳实践是利用接口,构造函数和final属性。
我已经设置了“最佳实践”服务接口,并提供了服务实现---使用了SpringService注解。
最佳实践服务接口
publicinterfaceBpService{ StringgetHello(); }
最佳实践服务实现
@Service publicclassBpServiceImplimplementsBpService{ @Override publicStringgetHello(){ return"TheBestHello!"; } }
使用ProjectLombok
现在,使用ProjectLombok进行依赖注入的最佳实践的秘诀在于:
- 声明一个final属性接口
- 为类添加ProjectLomboc注解@RequiredArgsConstructor
现在,ProjectLombok将为声明为final的所有属性生成一个构造函数。Spring会自动使用Lombok提供的构造函数来自动装配该片段。
LombokController
@RequiredArgsConstructor @Controller publicclassBpFinalConstructorController{ privatefinalBpServicebpService; publicStringsaySomething(){ returnbpService.getHello(); } }
这是执行此操作的真正好方法。您的代码保持非常干净。使用Spring时,通常需要多个自动装配属性。
当您需要添加另一个bean时,只需声明一个final属性。
如果您重构并且不再需要Spring托管的依赖项,则只需删除final属性。
你不再需要维护设置器或构造函数代码。ProjectLombok减轻了您的日常工作。
我在日常编码中一直使用这种技术。绝对是节省时间。并导致更干净的代码。未使用的属性和未使用的构造函数参数已一去不复返了。重构现在不那么痛苦了!
本文的源代码可在GitHub上找到。
以上就是Spring依赖注入实现示例的详细内容,更多关于Spring依赖注入的资料请关注毛票票其它相关文章!