Dagger 2 ReadMe
![Maven Central][mavenbadge-svg]
A fast dependency injector for Android and Java.
一个为Android和Java开发的高效的依赖注入框架
About Google's Fork
Dagger 2 is a compile-time evolution approach to dependency injection.
Taking the approach started in Dagger 1.x to its ultimate conclusion,
Dagger 2.x eliminates all reflection, and improves code clarity by
removing the traditional ObjectGraph/Injector in favor of user-specified
@Component
interfaces.
Dagger 2 是一个为了实现依赖注入的编译时改进. 从Dagger1.x到最后结果, Dagger 2.x去除了所有的反射, 通过以用户指定的@Component接口取代传统的[对象图片/注入]提高了代码的清晰度.
This github project represents the Dagger 2 development stream. The earlier
project page (Square, Inc's repository) represents the earlier 1.0
development stream. Both versions have benefitted from strong involvement from
Square, Google, and other contributors.
这个gitHub 项目代表了Dagger2的开发流, 早一点的项目代表的是早期1.0的开发流. 2个版本都受益于Square, Google和其它贡献者的深度参与.
Dagger is currently in active development, primarily internally at Google,
with regular pushes to the open-source community. Snapshot releases are
auto-deployed to sonatype's central maven repository on every clean build with
the version HEAD-SNAPSHOT
.
Dagger现在正处在积极发展中(主要在于Google内部), 经常被推送到开源社区. 在'HEAD-SANPSHOT'版本的每次构建操作会自动部署发布的快照到sonatype的中央maven仓库.
Dagger 2's main documentation website can be found here.
Documentation
You can find the dagger documentation here which has extended usage
instructions and other useful information. Substantial usage information can be
found in the API documentation.
你能在这里找到dagger文档这个网站有更多的使用文档和其它有用的信息.
重要的使用信息能在这里找到 API documentation
You can also learn more from the original proposal,
this talk by Greg Kick, and on the [email protected]
mailing list.
你也能从 the original proposal 和 this talk by Greg Kick,这里学到更多, 另外有讨论邮件 [email protected]
Installation(安装)
Bazel
If you build with bazel
, follow the bazel
documentation for referencing
external projects to include Dagger in your build.
如果你使用
bazel
构建, 跟随bazel
documentation for referencing
external projects 来集成Dagger到你的构建中
Given the following WORKSPACE
definition, you can reference dagger via
@com_google_dagger//:dagger_with_compiler
in your deps.
http_archive(
name = "com_google_dagger"
urls = ["https://github.com/google/dagger/archive/dagger-.zip"],
)
Other build systems(其它构建系统)
You will need to include the dagger-2.x.jar
in your application's runtime.
In order to activate code generation and generate implementations to manage
your graph you will need to include dagger-compiler-2.x.jar
in your build
at compile time.
你需要在你应用的运行时集成
dagger-2.x.jar
. 为了启动代码生成和管理图表的实现, 你需要在编译时集成dagger-compiler-2.x.jar
到你的构建系统中.
Maven
In a Maven project, include the dagger
artifact in the dependencies section
of your pom.xml
and the dagger-compiler
artifact as an
annotationProcessorPaths
value of the maven-compiler-plugin
:
在Maven项目中, 在
pom.xml
中引用dagger
依赖, 并且把dagger-compiler
artifact 作为maven-compiler-plugin
依赖的annotationProcessorPaths
值
com.google.dagger
dagger
2.x
org.apache.maven.plugins
maven-compiler-plugin
3.6.1
com.google.dagger
dagger-compiler
2.x
If you are using a version of the maven-compiler-plugin
lower than 3.5
, add
the dagger-compiler
artifact with the provided
scope:
如果你使用低于
3.5
的maven-compiler-plugin
, 给dagger-compiler
artifact配上provided
scope
com.google.dagger
dagger
2.x
com.google.dagger
dagger-compiler
2.x
provided
If you use the beta dagger-producers
extension (which supplies
parallelizable execution graphs), then add this to your maven configuration:
如果你使用试用版的
dagger-producers
扩展配置(which supplies
parallelizable execution graphs) 增加以下配置到maven中.
com.google.dagger
dagger-producers
2.x
Java Gradle
// Add plugin https://plugins.gradle.org/plugin/net.ltgt.apt
plugins {
id "net.ltgt.apt" version "0.10"
}
// Add Dagger dependencies
dependencies {
compile 'com.google.dagger:dagger:2.x'
apt 'com.google.dagger:dagger-compiler:2.x'
}
Android Gradle
// Add Dagger dependencies
dependencies {
compile 'com.google.dagger:dagger:2.x'
annotationProcessor 'com.google.dagger:dagger-compiler:2.x'
}
If you're using classes in dagger.android
you'll also want to include:
如果你使用
dagger.android
中的类, 你需要增加以下引用
compile 'com.google.dagger:dagger-android:2.x'
compile 'com.google.dagger:dagger-android-support:2.x' // if you use the support libraries
annotationProcessor 'com.google.dagger:dagger-android-processor:2.x'
If you're using a version of the Android gradle plugin below 2.2
, see
https://bitbucket.org/hvisser/android-apt.
如果你使用低于
2.2
版本的gradle插件, 查看https://bitbucket.org/hvisser/android-apt.
If you're using the Android Databinding library, you may want to
increase the number of errors that javac
will print. When Dagger prints an
error, databinding compilation will halt and sometimes print more than 100
errors, which is the default amount for javac
. For more information, see
Issue 306.
如果你正使用Android Databinding library, 你可能想增加
javac
打印出的errors的数量. 当Dagger打印错误时, 数据绑定编译会暂停并打印超100(javac
的默认总数)的错误信息. 更多信息请查看Issue 306
gradle.projectsEvaluated {
tasks.withType(JavaCompile) {
options.compilerArgs << "-Xmaxerrs" << "500" // or whatever number you want
}
}
Download
- 2.x (google/dagger)
- Dagger 2.0 Documentation
- Dagger 2.0 Javadocs
- Dagger development Javadocs (from the
master
branch
on GitHub) - Google's Dagger project site on GitHub
- rel="publisher">Google+ Dagger Project Page
- Google+ Dagger Users Community
- 1.x (square/dagger)
- Square's original Dagger project site on GitHub
- Square Open Source Community
If you do not use maven, gradle, ivy, or other build systems that consume
maven-style binary artifacts, they can be downloaded directly via the
Maven Central Repository.
Developer snapshots are available from Sonatype's
snapshot repository, and are built on a clean build of
the GitHub project's master branch.
Building Dagger
Dagger is built with bazel
. The tests can be run with bazel test //...
.
util/install-local-snapshot.sh
will build all of the Dagger libraries and
install a copy in your local maven repository with the version LOCAL-SNAPSHOT
.
License
Copyright 2012 The Dagger Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
单词
- evolution演变; 进化; 发展
- approach to接近
ultimate conclusion 最后结果
eliminates 消除
reflection 反射
clarity 清晰度.
ObjectGraph/Injector
in favor of 以取代
user-specified 用户指定的.
involvement 参与
Substantial 重要的
artifact: 人工制品.
UserGuide :
https://google.github.io/dagger/users-guide