Description

This project supports the automatic completion of the word.

Also, you can include points in the word. (like as related contents points for the Instagram)

Benchmark

Each step was tested 10 times. (10k words, 100k words, 100k fixed length words)

You can checkout the Autocomplete benchmark project for details and review/run the benchmarks yourself.

The average response rate is as follows :

^{¹ Environments : Local(macbook), 2.5 GHz Intel Core i7, 16GB 1600 MHz DDR3

² 10k words: https://github.com/first20hours/google-10000-english

³ 100k words: https://gist.github.com/h3xx/1976236}

How to use?

Add the following dependency in pom.xml (Java 8 maven artifact)

<dependency>
  <groupId>com.github.dma</groupId>
  <artifactId>autocomplete</artifactId>
  <version>1.0.1</version>
</dependency>

Bean Configuration

@Autowired
private StringRedisTemplate stringRedisTemplate;

@Bean(name = {"autocompleteKeyRepository", "keyRepository"})
public AutocompleteKeyRepository keyRepository() {
	AutocompleteKeyRepository keyRepository = new AutocompleteKeyServiceImpl(stringRedisTemplate);
	return keyRepository;
}

@Bean(name = {"autocompleteRepository"})
public AutocompleteRepository autocompleteRepository(AutocompleteKeyRepository autocompleteKeyRepository) {
	AutocompleteRepository autocompleteRepository = new AutocompleteServiceImpl(stringRedisTemplate, autocompleteKeyRepository);
	return autocompleteRepository;
}

Examples

@Autowired
private AutocompleteRepository autocompleteRepository;

@Test
public void autocomplete() throws Exception {
	String apple = "apple";

	// step1. clear a "apple"
	autocompleteRepository.clear(apple);

	// step2. Add a "apple"
	autocompleteRepository.add(apple);

	// step3. Get auto-complete words with prefix "a"
	List<AutocompleteData> autocompletes = autocompleteRepository.complete("a");

	Assert.assertNotNull(autocompletes);
	Assert.assertTrue(autocompletes.size() == 1);

	AutocompleteData autocompleteData = autocompletes.get(0);

	Assert.assertTrue(autocompleteData.getValue().equals(apple));
	Assert.assertTrue(autocompleteData.getScore() == 1);
}

Requirements

This project depend on spring-boot and spring-boot-redis (Prerequisites)

Java 1.8
Spring boot 1.2.8+ (spring-boot-starter-redis)
Redis 2.4+

Note

There are many places to repair.
All contributions are welcome.
Please use the GitHub issue tracker if you have any ideas or bugs to report.

Installation Redis

Download, extract and compile Redis with:

$ wget http://download.redis.io/releases/redis-5.0.3.tar.gz
$ tar xzf redis-5.0.3.tar.gz
$ cd redis-5.0.3
$ make

The binaries that are now compiled are available in the src directory. Run Redis with:

$ src/redis-server

diegomarinho / spring-boot-redis-auto-complete