Pro CDI 2 in Java EE 8 An In-Depth Guide to Context and Dependency Injection — Jan Beernink Arjan Tijms Pro CDI 2 in Java EE 8 An In-Depth Guide to Context and Dependency Injection Jan Beernink Arjan Tijms Pro CDI 2 in Java EE 8: An In-Depth Guide to Context and Dependency Injection Jan Beernink Arjan Tijms Dublin, Ireland Amsterdam, Noord-Holland, The Netherlands ISBN-13 (pbk): 978-1-4842-4362-6 ISBN-13 (electronic): 978-1-4842-4363-3 https://doi.org/10.1007/978-1-4842-4363-3 Copyright © 2019 by Jan Beernink and Arjan Tijms This work is subject to copyright. All rights are reserved by the Publisher, whether the whole or part of the material is concerned, specifically the rights of translation, reprinting, reuse of illustrations, recitation, broadcasting, reproduction on microfilms or in any other physical way, and transmission or information storage and retrieval, electronic adaptation, computer software, or by similar or dissimilar methodology now known or hereafter developed. Trademarked names, logos, and images may appear in this book. Rather than use a trademark symbol with every occurrence of a trademarked name, logo, or image we use the names, logos, and images only in an editorial fashion and to the benefit of the trademark owner, with no intention of infringement of the trademark. The use in this publication of trade names, trademarks, service marks, and similar terms, even if they are not identified as such, is not to be taken as an expression of opinion as to whether or not they are subject to proprietary rights. While the advice and information in this book are believed to be true and accurate at the date of publication, neither the authors nor the editors nor the publisher can accept any legal responsibility for any errors or omissions that may be made. The publisher makes no warranty, express or implied, with respect to the material contained herein. Managing Director, Apress Media LLC: Welmoed Spahr Acquisitions Editor: Steve Anglin Development Editor: Matthew Moodie Coordinating Editor: Mark Powers Cover designed by eStudioCalamar Distributed to the book trade worldwide by Springer Science+Business Media New York, 233 Spring Street, 6th Floor, New York, NY 10013. Phone 1-800-SPRINGER, fax (201) 348-4505, e-mail orders-ny@springer- sbm.com, or visit www.springeronline.com. Apress Media, LLC is a California LLC and the sole member (owner) is Springer Science + Business Media Finance Inc (SSBM Finance Inc). SSBM Finance Inc is a Delaware corporation. For information on translations, please e-mail [email protected]; for reprint, paperback, or audio rights, please email [email protected]. Apress titles may be purchased in bulk for academic, corporate, or promotional use. eBook versions and licenses are also available for most titles. For more information, reference our Print and eBook Bulk Sales web page at www.apress.com/bulk-sales. Any source code or other supplementary material referenced by the author in this book is available to readers on GitHub via the book’s product page, located at www.apress.com/978-1-4842-4362-6. For more detailed information, please visit www.apress.com/source-code. Printed on acid-free paper For Dominika, who encouraged me to write this book, and for my mum, dad and sister who supported me throughout. —Jan Beernink To my mother —Arjan Tijms Table of Contents About the Authors ����������������������������������������������������������������������������������������������������ix About the Technical Reviewer ���������������������������������������������������������������������������������xi Chapter 1: History of CDI ������������������������������������������������������������������������������������������1 A Time of Legends �������������������������������������������������������������������������������������������������������������������������1 Enter Gavin King ����������������������������������������������������������������������������������������������������������������������������9 Enter Rod Johnson ������������������������������������������������������������������������������������������������������������������������9 Enter Bob Lee ������������������������������������������������������������������������������������������������������������������������������11 The Conception of CDI �����������������������������������������������������������������������������������������������������������������15 The Next Generation��������������������������������������������������������������������������������������������������������������������26 Trouble in Paradise ���������������������������������������������������������������������������������������������������������������������32 A Brave New World ���������������������������������������������������������������������������������������������������������������������34 Chapter 2: Beans As the Component Model in EE ���������������������������������������������������37 What Is a Component Model? �����������������������������������������������������������������������������������������������������37 Managed ��������������������������������������������������������������������������������������������������������������������������������38 Scoped �����������������������������������������������������������������������������������������������������������������������������������42 Substitutable �������������������������������������������������������������������������������������������������������������������������43 Interceptable �������������������������������������������������������������������������������������������������������������������������46 Having a Lifecyle �������������������������������������������������������������������������������������������������������������������49 Named �����������������������������������������������������������������������������������������������������������������������������������52 Why the Plethora of Different Component Models in Java EE? ���������������������������������������������������55 CDI Beans as the Component Model in Java EE��������������������������������������������������������������������������57 Advantages of Using CDI by the Platform Internally��������������������������������������������������������������������60 v Table of ConTenTs Chapter 3: Identifying Beans ����������������������������������������������������������������������������������63 What Is a Bean? ��������������������������������������������������������������������������������������������������������������������������63 How Can You Identify a Bean? ����������������������������������������������������������������������������������������������������65 By Type ����������������������������������������������������������������������������������������������������������������������������������65 By Type and Qualifiers �����������������������������������������������������������������������������������������������������������69 By Name ��������������������������������������������������������������������������������������������������������������������������������82 Identifying and Retrieving Multiple Beans ����������������������������������������������������������������������������������84 Retrieving Beans via Custom Method Parameter Injection ���������������������������������������������������������87 Practical Example: Implementing Custom Method Injection �������������������������������������������������89 Chapter 4: Scopes and Contexts �����������������������������������������������������������������������������97 Using Scopes ������������������������������������������������������������������������������������������������������������������������������99 Built-in Scopes ��������������������������������������������������������������������������������������������������������������������������103 Application Scope ����������������������������������������������������������������������������������������������������������������103 Session Scope ���������������������������������������������������������������������������������������������������������������������105 Request Scope���������������������������������������������������������������������������������������������������������������������107 Conversation Scope �������������������������������������������������������������������������������������������������������������111 Dependent Scopes ��������������������������������������������������������������������������������������������������������������������114 Exposing Nonproxyable Types as Scoped Beans ����������������������������������������������������������������������115 Passivating Scopes �������������������������������������������������������������������������������������������������������������������116 Other Scopes Defined in Java EE ����������������������������������������������������������������������������������������������117 Scope init Events �����������������������������������������������������������������������������������������������������������������118 Custom Scopes �������������������������������������������������������������������������������������������������������������������������119 Custom Scope Annotation ���������������������������������������������������������������������������������������������������121 Context ��������������������������������������������������������������������������������������������������������������������������������������123 Extension ����������������������������������������������������������������������������������������������������������������������������������125 Passivation-Capable Scope �������������������������������������������������������������������������������������������������������135 Overriding Built-in Scopes ��������������������������������������������������������������������������������������������������������138 vi Table of ConTenTs Chapter 5: Events �������������������������������������������������������������������������������������������������141 Event Types �������������������������������������������������������������������������������������������������������������������������������141 Event Observers ������������������������������������������������������������������������������������������������������������������������142 Conditional Event Observers �����������������������������������������������������������������������������������������������144 Observer Ordering ���������������������������������������������������������������������������������������������������������������144 Event Metadata��������������������������������������������������������������������������������������������������������������������146 Firing an Event ��������������������������������������������������������������������������������������������������������������������������148 Generic Event Types ������������������������������������������������������������������������������������������������������������152 Observer Exceptions ������������������������������������������������������������������������������������������������������������153 Scopes and Event Delivery ��������������������������������������������������������������������������������������������������154 Transactional Events �����������������������������������������������������������������������������������������������������������������154 Asynchronous Events ����������������������������������������������������������������������������������������������������������������157 Observing Asynchronous Events �����������������������������������������������������������������������������������������158 Firing Asynchronous Events ������������������������������������������������������������������������������������������������160 Chapter 6: Decorators and Interceptors ���������������������������������������������������������������165 Decorators���������������������������������������������������������������������������������������������������������������������������������165 Interceptors �������������������������������������������������������������������������������������������������������������������������������171 Applying an Interceptor �������������������������������������������������������������������������������������������������������180 Interceptor Activation ����������������������������������������������������������������������������������������������������������182 Constructor Interceptors ������������������������������������������������������������������������������������������������������184 Interceptors and Producer Methods ������������������������������������������������������������������������������������185 Chapter 7: Dynamic Beans �����������������������������������������������������������������������������������189 Why Dynamic Beans? ���������������������������������������������������������������������������������������������������������������189 Creating Dynamic Beans �����������������������������������������������������������������������������������������������������������190 Manually Implementing a Bean<T> ������������������������������������������������������������������������������������190 Adding Dynamic Beans: Using Extensions ��������������������������������������������������������������������������������201 Discovering Plain Java Types ����������������������������������������������������������������������������������������������202 Discovering CDI Beans ��������������������������������������������������������������������������������������������������������204 Implementing Bean<T> Using a Configurator ���������������������������������������������������������������������206 Simulating Generic Producers with Dynamically Created Beans ����������������������������������������210 vii Table of ConTenTs Chapter 8: CDI in Java SE �������������������������������������������������������������������������������������213 Bootstrap API�����������������������������������������������������������������������������������������������������������������������������214 Bean Archive Scanning �������������������������������������������������������������������������������������������������������������218 Synthetic Bean Archive �������������������������������������������������������������������������������������������������������������218 Testing���������������������������������������������������������������������������������������������������������������������������������������221 Scopes ��������������������������������������������������������������������������������������������������������������������������������������224 Java FX��������������������������������������������������������������������������������������������������������������������������������������225 Replacing JavaFX Injection ��������������������������������������������������������������������������������������������������229 Java 9 Modules �������������������������������������������������������������������������������������������������������������������235 Index ���������������������������������������������������������������������������������������������������������������������241 viii About the Authors Jan Beernink works for Google and is a contributor to several projects related to OmniFaces. Jan holds an MSc degree in computer science from the Vrije Universiteit of Amsterdam, the Netherlands. Arjan Tijms works for Payara Services Ltd. and is a JSF (JSR 372) and Security API (JSR 375) EG member. He is the co-creator of the popular OmniFaces library for JSF that was a 2015 Duke’s Choice Award winner and is the main creator of a set of tests for the Java EE authentication SPI (JASPIC) that has been used by various Java EE vendors. Arjan holds an MSc degree in computer science from the University of Leiden, the Netherlands. ix About the Technical Reviewer Chád (“Shod”) Darby is an author, instructor, and speaker in the Java development world. As a recognized authority on Java applications and architectures, he has presented technical sessions at software development conferences worldwide. In his 15 years as a professional software architect, he’s had the opportunity to work for Blue Cross/Blue Shield, Merck, Boeing, Red Hat, and a handful of startup companies. Chád is a contributing author to several Java books, including Professional Java E-Commerce (Wrox Press), Beginning Java Networking (Wrox Press), and XML and Web Services Unleashed (Sams Publishing). Chád has Java certifications from Sun Microsystems and IBM. He holds a BS in computer science from Carnegie Mellon University. You can visit Chád’s blog at www.luv2code.com to view his free video tutorials on Java. You can also follow him on Twitter (@darbyluvs2code). xi