Bt：一个轻量级BitTorrent框架

Bt：一个轻量级BitTorrent框架

Change.org: Free Julian Assange, before it's too late. Sign to STOP the USA Extradition

A full-featured BitTorrent implementation in java 8 peer exchange | magnet links | DHT | encryption | LSD | private trackers | extended protocol | partial downloads | port forwarding

HOME – website with documentation and tutorialsRELEASE NOTES – list of features, bugfixes and improments for each versionUPGRADE INSTRUCTIONS – version migration guideFORUM – Google group for support and feedbackTROUBLESHOOTING - solutions for some common problemsLICENSE – licensed under Apache License 2.0

Runnable apps and demos

CLI – command-line downloaderPEER TRACKER – tracking of swarm statistics via eventsYOURIP MESSENGER – usage of custom messages

Media

HABRAHABR.RU: Пишем свой BitTorrent клиент на базе библиотеки Bt - Introductory article and demonstration of basic capabilities (in Russian)SMARTSPATE.COM: How To Write Your Own BitTorrent Client By Using Bt Library - English translation of the above article

Prerequisites

Currently, all peer connections are established via encryption negotation protocol (also called MSE handshake). If you're using Oracle JDK (pre 8u152), in order to be able to connect to peers you must install Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy. The reason for this requirement is that the MSE RC4 cipher uses 160 bit keys, while default Java installation allows at most 128 bit keys.

Usage

Most recent version available in Maven Central is 1.9.

Declare the following dependencies in your project’s pom.xml:

com.github.atomashpolskiy bt-core ${bt-version} com.github.atomashpolskiy bt-http-tracker-client ${bt-version} com.github.atomashpolskiy bt-dht ${bt-version} com.github.atomashpolskiy bt-upnp ${bt-version}

Building from source

git clone https://github.com/atomashpolskiy/bt.gitcd btmvn clean install -DskipTests

Code sample

// enable multithreaded verification of torrent dataConfig config = new Config() { @Override public int getNumOfHashingThreads() { return Runtime.getRuntime().availableProcessors() * 2; }};// enable bootstrapping from public routersModule dhtModule = new DHTModule(new DHTConfig() { @Override public boolean shouldUseRouterBootstrap() { return true; }});// get download directoryPath targetDirectory = Paths.get(System.getProperty("user.home"), "Downloads");// create file system based backend for torrent dataStorage storage = new FileSystemStorage(targetDirectory);// create client with a private runtimeBtClient client = Bt.client() .config(config) .storage(storage) .magnet("magnet:?xt=urn:btih:af0d9aa01a9ae123a73802cfa58ccaf355eb19f1") .autoLoadModules() .module(dhtModule) .stopWhenDownloaded() .build();// launchclient.startAsync().join();

What makes Bt stand out from the crowd

Flexibility

Being built around the Guice DI, Bt provides many options for tailoring the system for your specific needs. If something is a part of Bt, then it can be modified or substituted for your custom code.

Custom backends

Bt is shipped with a standard file-system based backend (i.e. you can download the torrent file to a storage device). However, the backend details are abstracted from the message-level code. This means that you can use your own backend by providing a storage unit implementation.

Protocol extensions

One notable customization scenario is extending the standard BitTorrent protocol with your own messages. BitTorrent's BEP-10 provides a native support for protocol extensions, and implementation of this standard is already included in Bt. Contribute your own Messages, byte manipulating MessageHandlers, message consumers and producers; supply any additional info in ExtendedHandshake.

Test infrastructure

To allow you test the changes that you've made to the core, Bt ships with a specialized framework for integration tests. Create an arbitrary-sized swarm of peers inside a simple JUnit test, set the number of seeders and leechers and start a real torrent session on your localhost. E.g. create one seeder and many leechers to stress test the network overhead; use a really large file and multiple peers to stress test your newest laptop's expensive SSD storage; or just launch the whole swarm in no-files mode and test your protocol extensions.

Parallel downloads

Bt has out-of-the-box support for multiple simultaneous torrent sessions with minimal system overhead.

Partial downloads

Bt has an API for selecting only a subset of torrent files to download. See the bt.TorrentClientBuilder.fileSelector(TorrentFileSelector) client builder method. File selection works for both .torrent file-based and magnet link downloads.

Java 8 CompletableFuture

Client API leverages the asynchronous java.util.concurrent.CompletableFuture to provide the most natural way for co-ordinating multiple torrent sessions. E.g. use CompletableFuture.allOf(client1.startAsync(...), client2.startAsync(...), ...).join(). Or create a more sophisticated processing pipeline.

And much more...

check out Release Notes for details!

Troubleshooting

Can't connect to peers, everything else seems to work

If you're using an Oracle JDK, make sure that you have installed Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy.

Other BitTorrent clients can't connect to a Bt client / No incoming connections when seeding

a) If you're behind a firewall and/or a NAT (e.g. a router), make sure they are configured to allow incoming TCP and UDP connections on the ports used by Bt. Default Bt ports are 6891 and 49001 for BitTorrent and DHT respectively. NAT must additionally be configured to forward all incoming traffic on these ports to the host, that Bt is running on.

b) Many popular BitTorrent clients use UPnP and NAT-PMP to automatically configure port forwarding on NATs. Since 1.8 Bt does this as well, so make sure to include bt-upnp module in the list of dependencies.

There are exceptions in the build log (but the build completes successfully)

This is perfectly fine. Some of the tests verify that the exceptions are thrown in certain cases, hence the exception messages.

Can't run the CLI on Windows XP (java.io.IOException: Cannot run program "/bin/stty")

CLI GUI indeed does not work on Windows XP. Run in headless mode by using -H flag.

Can't connect to peers on Windows 7/8/10

There seem to be some issues with dual-stack networking in Windows JDK (e.g. see this question on SO), with Java trying to use IPv6 address, when it's not really available in the system. The simplest solution is to force Java to use IPv4 by setting java-.preferIPv4Stack property to true.

Support and feedback

Any thoughts, ideas, criticism, etc. are welcome, as well as votes for new features and BEPs to be added. You have the following options to share your ideas, receive help or report bugs:

open a new GitHub issuepost your question on the Bt forum

List of supported BEPs

BEP-3: The BitTorrent Protocol SpecificationBEP-5: DHT ProtocolBEP-9: Extension for Peers to Send Metadata FilesBEP-10: Extension ProtocolBEP-11: Peer Exchange (PEX)BEP-12: Multitracker metadata extensionBEP-14: Local Service DiscoveryBEP-15: UDP Tracker ProtocolBEP-20: Peer ID ConventionsBEP-23: Tracker Returns Compact Peer ListsBEP-27: Private TorrentsBEP-41: UDP Tracker Protocol ExtensionsMessage Stream Encryption

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。