Hi, On Thu, Dec 6, 2018 at 4:14 AM Imteyaz Khan <khan.imte...@gmail.com> wrote: > > I have just started documenting module 'dubbo-filter', below are example > of mine, this is just to make sure I am in align with the documentation > style
Looks good! Please go head and send the pull request! > > /** > * CacheFilter is a core component of dubbo.Enabling <b>cache</b> key > of service,method,consumer or provider dubbo will cache method return > value. > * Along with cache key we need to configure cache type. Dubbo default > implemented cache types are > * <li>lur</li> > * <li>threadlocal</li> > * <li>jcache</li> > * <li>expiring</li> > * > * <pre> > * e.g. 1)<dubbo:service cache="lru" /> > * 2)<dubbo:service /> <dubbo:method name="method2" > cache="threadlocal" /> <dubbo:service/> > * 3)<dubbo:provider cache="expiring" /> > * 4)<dubbo:consumer cache="jcache" /> > * > *If cache type is defined in method level then method level type will > get precedence. According to above provided > *example, if service has two method, method1 and method2, method2 > will have cache type as <b>threadlocal</b> where others will > *be backed by <b>lru</b> > *</pre> > * > * @see org.apache.dubbo.rpc.Filter > * @see org.apache.dubbo.cache.support.lru.LruCacheFactory > * @see org.apache.dubbo.cache.support.lru.LruCache > * @see org.apache.dubbo.cache.support.jcache.JCacheFactory > * @see org.apache.dubbo.cache.support.jcache.JCache > * @see org.apache.dubbo.cache.support.threadlocal.ThreadLocalCacheFactory > * @see org.apache.dubbo.cache.support.threadlocal.ThreadLocalCache > * @see org.apache.dubbo.cache.support.expiring.ExpiringCacheFactory > * @see org.apache.dubbo.cache.support.expiring.ExpiringCache > * > */ > @Activate(group = {Constants.CONSUMER, Constants.PROVIDER}, value = > Constants.CACHE_KEY) > public class CacheFilter implements Filter { > > .... > > ..... > > } > > > On Wed, Dec 5, 2018 at 8:20 PM Imteyaz Khan <khan.imte...@gmail.com> wrote: > > > Just to make sure I have not misunderstood what mentioned earlier by > > 'Filter' is 'dubbo-filter' correct? > > > > On Wed, Dec 5, 2018 at 7:00 PM Imteyaz Khan <khan.imte...@gmail.com> > > wrote: > > > >> Thanks a lot for the start, much appreciated. > >> > >> > >> > >> On Wed, Dec 5, 2018 at 6:31 PM yuhang xiu <carry...@gmail.com> wrote: > >> > >>> In addition, we strongly encourage open discussion. > >>> You can post your comments on a Filter directly here. There will be some > >>> people who know more about dubbo to review and discuss. > >>> > >>> Of course, any problem can be raised here. We will answer as soon as > >>> possible. > >>> > >>> yuhang xiu <carry...@gmail.com> 于2018年12月5日周三 下午8:58写道: > >>> > >>> > very sorry. I have some work now, so I didn't respond to your email in > >>> > time. > >>> > I am very willing to help you with the completion of the comments. If > >>> you > >>> > are a newbie, I suggest you start with a simple logic. > >>> > Which parts of the logic are relatively simple? At present, I think > >>> that > >>> > our filter-related implementation is relatively simple (such as > >>> > ActiveLimitFilter). You don't know the principle of dubbo at all, and > >>> you > >>> > can understand the code and complete the comments more easily. You can > >>> > start with the Filter related class and complete some of the comments. > >>> > > >>> > When you think that you know enough about dubbo, you can do some core > >>> > module comments, such as protocol-related comments. > >>> > > >>> > Imteyaz Khan <khan.imte...@gmail.com> 于2018年12月5日周三 下午3:05写道: > >>> > > >>> >> Hi All, > >>> >> Trust you all are doing well. I am new to this community or even > >>> new to > >>> >> any open source development community. Had a chance to go through one > >>> of > >>> >> the dubbo github issue #2884('We need more code comments'), which was > >>> >> marked as 'good first issue'. So thought it could be a good start for > >>> me > >>> >> to > >>> >> start from here, but being new to open source and also to dubbo I am > >>> very > >>> >> nervous from where and how to start. I will be great if team can help > >>> me > >>> >> and guide me too to assist you in any way I can. > >>> >> > >>> >> Regards > >>> >> Imteyaz > >>> >> > >>> > > >>> > >> -- Best Regards! Huxing