7

BestPractices

Copybara-Service edited this page 2021-04-08 14:31:18 -07:00

Table of Contents

• Guice Best Practices

Guice Best Practices

• Minimize mutability
• Inject only direct dependencies
• Use the Injector as little as possible (preferably only once)
• Avoid cyclic dependencies
• Avoid static state
• Use @Nullable
• Modules should be fast and side-effect free
• Be careful about I/O in Providers
• Avoid conditional logic in modules
• Keep constructors as hidden as possible
• Avoid binding Closable resources
• Prefer @Provides methods over the binding DSL
• Avoid calling @Provides methods and @Inject constructors directly
• Don't reuse binding annotations (aka @Qualifiers)
• Organize modules by feature, not by class type
• Document the public bindings provided by modules

• User's Guide

  • Overview
  • Motivation
  • Getting Started
  • Mental Model
  • Scopes
  • Bindings
    • Linked Bindings
    • Binding Annotations
    • Instance Bindings
    • @Provides Methods
    • Provider Bindings
    • Untargeted Bindings
    • Constructor Bindings
    • Built-in Bindings
    • Just-In-Time Bindings
    • Multibindings
    • Restricting the Binding Source
  • Injections
    • Injecting Providers
  • AOP
  • JSR-330
  • Guice in Kotlin

• Common Guice Errors

• Best Practices

• Frequently Asked Questions

• Integration

  • Web and Servlets
    • Getting Started
    • Configuring Guice Servlet
    • Advanced Topics
    • Inspecting Servlet Bindings
  • Google App Engine
  • Persistence
    • Getting Started
    • Using JPA
    • Transactions and Units of Work
    • Multiple persistence modules
  • OSGi
  • Struts 2 Integration
  • Third Party Modules

• Extensions

  • Extending Guice
  • Elements SPI
  • Extensions SPI
  • AssistedInject
  • Custom Scopes
  • Custom Injections
  • Throwing Providers
  • Graphing Guice Applications
  • Testing Support
    • Bound Fields

• Internals

  • Bootstrap
  • Binding Resolution
  • Injection Points
  • Class Loading
  • Optional AOP
  • Spring Comparison

• Releases

  • Guice 7.0.0
  • Guice 6.0.0
  • Guice 5.1.0
  • Guice 5.0.1
  • Guice 5.0.0
  • Guice 4.2.3
  • Guice 4.2.2
  • Guice 4.2.1
  • Guice 4.2
  • Guice 4.1
  • Guice 4.0
  • Guice 3.0
  • Guice 2.0
  • Guice 1.0

• Community

  • External Documentation
  • Apps that use Guice
  • Discussions