The next generation of URL Router with cleaner code and improved performance up to 3000% faster than previous version, support modularization, easier to use, and many other benefits!
You need this if you have only 1 domain to be processed:
val router = SimpleNeuro()
router.setBase(Uri.parse("https://www.mywebsite.com"))
// https://www.mywebsite.com/login
router.addPath("/login") {
// goto login
}
// https://www.mywebsite.com/messages/1234
router.addPath("/messages/<message_id>") {
val messageId = it.variables.optString("message_id")
// open message with id 1234
}
// https://www.mywebsite.com/promo?source=banner
router.addPath("/promo") {
val source = it.queries.optString("source")
// open promo with source `banner`
}
And use this to execute URL:
router.proceed(url)
You need this if your routing is super complex:
Soma is used to filter base URL including scheme, domain, and port.
There are 3 types of Soma class:
Soma
: URL that has one or more paths to be processed, multiple instances are allowed.
object MyWebsiteSoma : Soma("my_website") {
val schemes = listOf("https")
val hosts = listOf("www.mywebsite.com", "m.mywebsite.com")
override fun onSomaProcess(signal: Signal): Boolean {
// preprocess URL here
// return false/super if you need to forward process to branch
// return true if you want to stop processing
return super.onSomaProcess(signal)
}
override fun onProcessNoBranch(signal: Signal) {
// it will be passed if URL inputted has no path, like: https://www.website.com
}
override fun onProcessOtherBranch(signal: Signal) {
// it will be passed if where is no match for URL in listed branch, like: https://www.website.com/unlistedpath
}
}
SomaOnly
: URL that doesn't have path to be processed, multiple instances are allowed.
object MyOtherWebsiteSoma : SomaOnly("my_other_website") {
val schemes = listOf("http")
val hosts = listOf("www.myotherwebsite.com")
val ports = listOf(8089)
override fun onSomaProcess(signal: Signal) {
// process URL
}
}
SomaFallback
: This is a fallback when there is no match for other defined Somas, only single instance is allowed.
object OtherSoma : SomaFallback() {
override fun onSomaProcess(signal: Signal) {
// process URL
}
}
Notes:
- It's a good practise to make Soma subclasses in singleton object, because it's easier to manage and reusable
- If you don't define
schemes
,hosts
, andports
, it means that it's optional, any value or no value will be accepted.
AxonBranch is used to filter path after being processed by Soma.
Register all paths in your MainActivity
, or even better in subclass of Application
.
val router = Neuro()
override fun onCreate() {
router.connect(MyWebsiteSoma, AxonBranch("/login") {
// goto login
})
router.connect(MyWebsiteSoma, AxonBranch("/messages/<message_id>") {
val messageId = it.variables.optString("message_id")
// open message with id 1234
})
router.connect(MyWebsiteSoma, AxonBranch("/promo") {
val source = it.queries.optString("source")
// open promo with source `banner`
})
// for SomaOnly and SomaFallback
router.connect(MyOtherWebsiteSoma)
router.connect(OtherSoma)
}
- Separate process between finding and processing route for optimization.
- Pass context from
proceed
intoSignalAction
callback. - Pass any params bundled in
args
fromprocees
intoSignalAction
callback. - Intercept
SignalAction
before doing process on eachproceed
call. - Intercept globally
SignalAction
before doing any process to it. - Find route without processing the URL.
- Set priority for sorting in
Soma
andSomaOnly
. - Expression for
scheme
,host
, andpath
is highly configurable. - May use
getString()
for nullability oroptString()
for nonnullability.
Used to take part of scheme
, host
, or path
of URL. This language may not work properly in SimpleNeuro
. You may take variable value using Signal.variables.getString(String)
or any other provided types.
- Used for replacing any character except
/
- If you need to replace any character including
/
, you may use patterned variable - Regex:
[^/]+
-> Any character more than 1 except/
- Used for getting value inside URL
- Variable name can only use
A-Z
,a-z
,0-9
, and_
- Regex:
[^/]+
-> Any character more than 1 except/
- Used for getting value inside URL
- Variable name can only use
A-Z
,a-z
,0-9
, and_
- Variable name and regex separated with
:
- Regex: as written (can throw
PatternSyntaxException
when regex string is invalid)
Add this line in your build.gradle
file:
implementation 'com.mrhabibi:neuro:$latestVersion'
This library is hosted in the JCenter repository, so you have to ensure that the repository is included:
buildscript {
repositories {
jcenter()
}
}
Feel free to create issues and pull requests.
Neuro library for Android
Copyright (c) 2019 mrhabibi (https://github.com/bukalapak).
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.