Jak filtrować NSFetchedResultsController (CoreData) za pomocą UISearchDisplayController/UISearchBar

Niektórzy komentowali, że można to zrobić za pomocą jednego NSFetchedResultsController. To właśnie zrobiłem, a oto szczegóły. To rozwiązanie zakłada, że po prostu chcesz odfiltrować tabelę i zachować wszystkie inne aspekty (kolejność sortowania, układ komórek itp.) wyników wyszukiwania.

Najpierw zdefiniuj dwie właściwości w swojej podklasie UITableViewController (z odpowiednimi @synthesize i dealloc, jeśli ma to zastosowanie):

@property (nonatomic, retain) UISearchDisplayController *searchController;
@property (nonatomic, retain) NSString *searchString;

Po Drugie, zainicjuj pasek wyszukiwania w metodzie viewDidLoad: twojego UITableViewController podklasa:

UISearchBar *searchBar = [[UISearchBar alloc] initWithFrame:CGRectMake(0,0,self.tableView.frame.size.width,44)]; 
searchBar.placeholder = @"Search";
searchBar.delegate = self;
self.searchController = [[[UISearchDisplayController alloc] initWithSearchBar:searchBar contentsController:self] autorelease];
self.searchController.delegate = self;
self.searchController.searchResultsDataSource = self;   
self.searchController.searchResultsDelegate = self; 
self.tableView.tableHeaderView = self.searchController.searchBar;
[searchBar release];

Po Trzecie, zaimplementuj UISearchDisplayController deleguj metody w następujący sposób:

// This gets called when you start typing text into the search bar
-(BOOL)searchDisplayController:(UISearchDisplayController *)_controller shouldReloadTableForSearchString:(NSString *)_searchString {
   self.searchString = _searchString;
   self.fetchedResultsController = nil;
   return YES;
}

// This gets called when you cancel or close the search bar
-(void)searchDisplayController:(UISearchDisplayController *)controller willUnloadSearchResultsTableView:(UITableView *)tableView {
   self.searchString = nil;
   self.fetchedResultsController = nil;
   [self.tableView reloadData];
}

Wreszcie w metodzie fetchedResultsController Zmień NSPredicate w zależności self.searchString jest zdefiniowane:

-(NSFetchedResultsController *)fetchedResultsController {
   if (fetchedResultsController == nil) {

       // removed for brevity

      NSPredicate *predicate;

      if (self.searchString) {
         // predicate that uses searchString (used by UISearchDisplayController)
         // e.g., [NSPredicate predicateWithFormat:@"name CONTAINS[cd] %@", self.searchString];
          predicate = ... 
      } else {
         predicate = ... // predicate without searchString (used by UITableViewController)
      }

      // removed for brevity

   }

   return fetchedResultsController;
} 

Zajęło mi kilka prób, żeby to zadziałało...

Moim kluczem do zrozumienia było uświadomienie sobie, że tutaj działają dwa widoki tableview. Jeden zarządzany przez mój viewcontroller i jeden zarządzany przez searchviewcontroller, a następnie mogłem przetestować, aby zobaczyć, który jest aktywny i zrobić właściwą rzecz. Dokumentacja też była pomocna:

Http://developer.apple.com/library/ios/#documentation/uikit/reference/UISearchDisplayController_Class/Reference/Reference.html

Oto co zrobiłem -

Dodano flagę wyszukiwania:

@interface ItemTableViewController : UITableViewController <NSFetchedResultsControllerDelegate, UISearchDisplayDelegate, UISearchBarDelegate> {

    NSString *sectionNameKeyPath;
    NSArray *sortDescriptors;


@private
    NSFetchedResultsController *fetchedResultsController_;
    NSManagedObjectContext *managedObjectContext_;

    BOOL searchIsActive;

}

@property (nonatomic, retain) NSManagedObjectContext *managedObjectContext;
@property (nonatomic, retain) NSFetchedResultsController *fetchedResultsController;
@property (nonatomic, retain) NSString *sectionNameKeyPath;
@property (nonatomic, retain) NSArray *sortDescriptors;
@property (nonatomic) BOOL searchIsActive;

Dodano syntezę w pliku implementacji.

Następnie dodałem te metody do wyszukiwania:

#pragma mark -
#pragma mark Content Filtering

- (void)filterContentForSearchText:(NSString*)searchText scope:(NSString*)scope
{
    NSFetchRequest *aRequest = [[self fetchedResultsController] fetchRequest];

    NSPredicate *predicate = [NSPredicate predicateWithFormat:@"name BEGINSWITH[cd] %@", searchText];

    [aRequest setPredicate:predicate];

    NSError *error = nil;
    if (![[self fetchedResultsController] performFetch:&error]) {
        // Handle error
        NSLog(@"Unresolved error %@, %@", error, [error userInfo]);
        abort();
    }  

}

#pragma mark -
#pragma mark UISearchDisplayController Delegate Methods

- (BOOL)searchDisplayController:(UISearchDisplayController *)controller shouldReloadTableForSearchString:(NSString *)searchString
{
    [self filterContentForSearchText:[self.searchDisplayController.searchBar text] scope:nil];

    return YES;
}

/*
- (BOOL)searchDisplayController:(UISearchDisplayController *)controller shouldReloadTableForSearchScope:(NSInteger)searchOption
{
    return YES;
}
*/

- (void)searchDisplayControllerWillBeginSearch:(UISearchDisplayController *)controller {
    [self setSearchIsActive:YES];
    return;
}

- (void)searchDisplayControllerDidEndSearch:(UISearchDisplayController *)controller 
{
    NSFetchRequest *aRequest = [[self fetchedResultsController] fetchRequest];

    [aRequest setPredicate:nil];

    NSError *error = nil;
    if (![[self fetchedResultsController] performFetch:&error]) {
        // Handle error
        NSLog(@"Unresolved error %@, %@", error, [error userInfo]);
        abort();
    }  

    [self setSearchIsActive:NO];
    return;
}

Następnie w controllerWillChangeContent:

- (void)controllerWillChangeContent:(NSFetchedResultsController *)controller 
{
    if ([self searchIsActive]) {
        [[[self searchDisplayController] searchResultsTableView] beginUpdates];
    }
    else  {
        [self.tableView beginUpdates];
    }
}

I controllerDidChangeContent:

- (void)controllerDidChangeContent:(NSFetchedResultsController *)controller 
{
    if ([self searchIsActive]) {
        [[[self searchDisplayController] searchResultsTableView] endUpdates];
    }
    else  {
        [self.tableView endUpdates];
    }
}

I usuń pamięć podręczną podczas resetowania predykatu.

Stanąłem przed tym samym zadaniem i znalazłem najprostszy możliwy sposób , aby go rozwiązać. krótko: musisz zdefiniować jeszcze jedną metodę, bardzo podobną do {[3] } z niestandardowym predykatem złożonym.

W moim osobistym przypadku moje -fetchedResultsController wygląda tak:

- (NSFetchedResultsController *) fetchedResultsController
{
    if (fetchedResultsController != nil)
    {
        return fetchedResultsController;
    }
    NSFetchRequest *fetchRequest = [[NSFetchRequest alloc] init];
    NSEntityDescription *entity = [NSEntityDescription entityForName:@"Client"
                                              inManagedObjectContext:[[PTDataManager sharedManager] managedObjectContext]];
    [fetchRequest setEntity:entity];

    NSPredicate *predicate = [NSPredicate predicateWithFormat:@"agency_server_id == %@", agency.server_id];
    fetchRequest.predicate = predicate;

    NSSortDescriptor *sortByName1Descriptor = [[NSSortDescriptor alloc] initWithKey:@"lastname" ascending:YES];
    NSSortDescriptor *sortByName2Descriptor = [[NSSortDescriptor alloc] initWithKey:@"firstname" ascending:YES];
    NSSortDescriptor *sortByName3Descriptor = [[NSSortDescriptor alloc] initWithKey:@"middlename" ascending:YES];
    NSArray *sortDescriptors = [[NSArray alloc] initWithObjects: sortByName1Descriptor, sortByName2Descriptor, sortByName3Descriptor, nil];

    fetchRequest.sortDescriptors = sortDescriptors;

    fetchedResultsController = [[NSFetchedResultsController alloc]initWithFetchRequest:fetchRequest managedObjectContext:[[PTDataManager sharedManager] managedObjectContext] sectionNameKeyPath:nil cacheName:nil];
    fetchedResultsController.delegate = self;
    return fetchedResultsController;
}

Jak widzisz, ściągam klientów jednej agencji filtrowanej przez agency.server_id predykat. W rezultacie odzyskuję swoją zawartość w tableView (wszystkie związane z implementacją kodu tableView i fetchedResultsController są dość standardowe) jako cóż. Aby zaimplementować searchField definiuję metodę delegowania UISearchBarDelegate. Uruchamiam go metodą wyszukiwania, powiedzmy -reloadTableView:

- (void)searchBar:(UISearchBar *)searchBar textDidChange:(NSString *)searchText
{
    [self reloadTableView];
}

I oczywiście definicja -reloadTableView:

- (void)reloadTableView
{
    NSFetchRequest *fetchRequest = [[NSFetchRequest alloc] init];
    NSEntityDescription *entity = [NSEntityDescription entityForName:@"Client"
                                              inManagedObjectContext:[[PTDataManager sharedManager] managedObjectContext]];
    [fetchRequest setEntity:entity];

    NSSortDescriptor *sortByName1Descriptor = [[NSSortDescriptor alloc] initWithKey:@"lastname" ascending:YES];
    NSSortDescriptor *sortByName2Descriptor = [[NSSortDescriptor alloc] initWithKey:@"firstname" ascending:YES];
    NSSortDescriptor *sortByName3Descriptor = [[NSSortDescriptor alloc] initWithKey:@"middlename" ascending:YES];
    NSArray *sortDescriptors = [[NSArray alloc] initWithObjects: sortByName1Descriptor, sortByName2Descriptor, sortByName3Descriptor, nil];
    fetchRequest.sortDescriptors = sortDescriptors;

    NSPredicate *idPredicate = [NSPredicate predicateWithFormat:@"agency_server_id CONTAINS[cd] %@", agency.server_id];
    NSString *searchString = self.searchBar.text;
    if (searchString.length > 0)
    {
        NSPredicate *firstNamePredicate = [NSPredicate predicateWithFormat:@"firstname CONTAINS[cd] %@", searchString];
        NSPredicate *lastNamePredicate = [NSPredicate predicateWithFormat:@"lastname CONTAINS[cd] %@", searchString];
        NSPredicate *middleNamePredicate = [NSPredicate predicateWithFormat:@"middlename CONTAINS[cd] %@", searchString];
        NSPredicate *orPredicate = [NSCompoundPredicate orPredicateWithSubpredicates:[NSArray arrayWithObjects:firstNamePredicate, lastNamePredicate, middleNamePredicate, nil]];
        NSPredicate *andPredicate = [NSCompoundPredicate andPredicateWithSubpredicates:[NSArray arrayWithObjects:idPredicate, nil]];
        NSPredicate *finalPred = [NSCompoundPredicate andPredicateWithSubpredicates:[NSArray arrayWithObjects:orPredicate, andPredicate, nil]];
        [fetchRequest setPredicate:finalPred];
    }
    else
    {
        [fetchRequest setPredicate:idPredicate];
    }

    self.fetchedResultsController = [[NSFetchedResultsController alloc]initWithFetchRequest:fetchRequest managedObjectContext:[[PTDataManager sharedManager] managedObjectContext] sectionNameKeyPath:nil cacheName:nil];
    self.fetchedResultsController.delegate = self;

    NSError *error = nil;
    if (![self.fetchedResultsController performFetch:&error])
    {
        NSLog(@"Unresolved error %@, %@", [error localizedDescription], [error localizedFailureReason]);
    }; 

    [self.clientsTableView reloadData];
}

Ten kod jest bardzo podobny do pierwszego, "standard" -fetchedResultsController ale wewnątrz instrukcji if-else jest:

+andPredicateWithSubpredicates: - za pomocą tej metody możemy ustawić predykat, aby zapisać wyniki naszego głównego pierwszego pobrania w tableView

+orPredicateWithSubpredicates - za pomocą tej metody filtrujemy istniejące pobieranie według search query from searchBar

Na końcu ustawiam tablicę predykatów jako predykat złożony dla tego konkretnego pobierania. I dla wymaganych predykatów, lub dla opcjonalnych.

I to wszystko! Nie musisz niczego więcej wdrażać. Szczęśliwego kodowania!

Czy używasz live search?

Jeśli nie jesteś, prawdopodobnie potrzebujesz tablicy (lub kontrolera NSFetchedResultsController) z poprzednimi wyszukiwaniami, które użyłeś, gdy użytkownik naciśnie "Szukaj", powiesz FetchedResults, aby zmienił predykat.

Tak czy inaczej, będziesz musiał za każdym razem odbudować swoje pobrane wyniki. Polecam używać tylko jednego kontrolera NSFetchedResultsController, ponieważ będziesz musiał powielać swój kod dużo i nie musisz marnować pamięci w czymś, czego nie jesteś pokazuję.

Upewnij się, że masz zmienną NSString "searchParameters" i że metoda fetchedresults przebudowuje ją w razie potrzeby, używając parametrów wyszukiwania, jeśli są dostępne, powinieneś po prostu zrobić:

A) Ustaw "searchParameters" na coś (lub nil, jeśli chcesz wszystkie wyniki).

B) zwolnić i ustawić na nil bieżący obiekt NSFetchedResultsController.

C) przeładuj dane tabeli.

Oto prosty kod:

- (void)searchString:(NSString*)s {
    self.searchResults = s;
    [fetchedResultsController release];
    fetchedResultsController = nil;
    [self.tableView reloadData];
}

-(NSFetchedResultsController *)fetchedResultsController {
    if (fetchedResultsController != nil) {
        return fetchedResultsController;
    }

    NSFetchRequest *fetchRequest = [[NSFetchRequest alloc] init];
    NSEntityDescription *entity = [NSEntityDescription entityForName:@"EntityName" inManagedObjectContext:self.context];
    [fetchRequest setEntity:entity];

    [fetchRequest setFetchBatchSize:20];

    // searchResults is a NSString*
    if (searchResults != nil) {
        NSPredicate *predicate = [NSPredicate predicateWithFormat:@"name LIKE %@",searchResults];
        [fetchRequest setPredicate:predicate];
    }

    fetchedResultsController = 
    [[NSFetchedResultsController alloc] initWithFetchRequest:fetchRequest 
        managedObjectContext:self.context sectionNameKeyPath:nil 
        cacheName:nil];
    fetchedResultsController.delegate = self;

    [fetchRequest release];

    return fetchedResultsController;    
}

Swift 3.0, UISearchController, NSFetchedResultsController i Core Data

Ten kod będzie działał na Swift 3.0 z Core Data! Do filtrowania i przeszukiwania obiektów z modelu potrzebna jest pojedyncza metoda delegata i kilka linii kodu. Nic nie będzie potrzebne, jeśli zaimplementujesz wszystkie metody FRC i ich metody delegate oraz searchController.

The UISearchResultsUpdating protocol method

func updateSearchResults(for searchController: UISearchController) {

    let text = searchController.searchBar.text

    if (text?.isEmpty)! {
       // Do something 
    } else {
        self.fetchedResultsController.fetchRequest.predicate = NSPredicate(format: "( someString contains[cd] %@ )", text!)
    }
    do {
        try self.fetchedResultsController.performFetch()
        self.tableView.reloadData()
    } catch {}
}

SWIFT 3.0

Użyj pola tekstowego, UISearchDisplayController jest przestarzały od iOS 8, musisz użyć UISearchController. Zamiast zajmować się kontrolerem wyszukiwania, dlaczego nie stworzyć własnego mechanizmu wyszukiwania? Możesz dostosować go bardziej i mieć większą kontrolę nad nim, i nie musisz się martwić o zmianę SearchController i / lub jest przestarzały.

Ta metoda działa bardzo dobrze i nie wymaga dużo kodu. Wymaga użycia podstawowych danych i zaimplementuj jednak Kontroler NSFetchedResultsController.

Najpierw Utwórz pole tekstowe i zarejestruj je za pomocą metody:

searchTextField?.addTarget(self, action: #selector(textFieldDidChange), for: UIControlEvents.editingChanged)

Następnie utwórz metodę textFieldDidChange, opisaną w selektorze po dodaniu celu:

func textFieldDidChange() {
    if let queryString = searchTextField.text {
        filterList(queryString)
        self.tableView.reloadData()
    }
}

Następnie chcesz filtrować listę w metodzie filterList() używając predykatu NSPredicate lub NSCompound, jeśli jest on bardziej złożony. W mojej metodzie filterList filtruję na podstawie nazwy encji i nazwy obiektu "podkategorie" encji (jeden do wiele relacji).

func filterList(_ queryString: String) {
    if let currentProjectID = Constants.userDefaults.string(forKey: Constants.CurrentSelectedProjectID) {
        if let currentProject = ProjectDBFacade.getProjectWithID(currentProjectID) {
            if (queryString != ""){
                let categoryPredicate = NSPredicate(format: "name CONTAINS[c] %@ && project == %@", queryString, currentProject)
                let subCategoryPredicate = NSPredicate(format: "subCategories.name CONTAINS[c] %@ && project == %@", queryString, currentProject)
                let orPredicate = NSCompoundPredicate(type: .or, subpredicates: [categoryPredicate, subCategoryPredicate])
                fetchedResultsController.fetchRequest.predicate = orPredicate
            }else{
                fetchedResultsController.fetchRequest.predicate = NSPredicate(format: "project == %@", currentProject)
            }

            do {
                try fetchedResultsController.performFetch()
            } catch {
                print("Error:  Could not fetch fetchedResultsController")
            }
        }
    }
}

Myślę, że Luka ma do tego lepsze podejście. Zobacz i jego powód

Nie używa FetchedResultsController, ale używa pamięci podręcznej podczas wyszukiwania, stąd wyniki wyszukiwania pojawiają się znacznie szybciej, gdy użytkownik wpisuje więcej w pasku wyszukiwania

Użyłem jego podejścia w mojej aplikacji i Działa OK. Pamiętaj również, jeśli chcesz pracować z obiektem modelu, zrób to tak prosto, jak to możliwe, zobacz moją odpowiedź na temat setPropertiesToFetch

Oto sposób obsługi fetchedResults z wieloma zestawami danych, który jest zarówno prosty, jak i wystarczająco ogólny, aby można go było zastosować niemal wszędzie. Po prostu chwyć swoje główne wyniki do tablicy, gdy jest jakiś warunek.

NSArray *results = [self.fetchedResultsController fetchedObjects];

Przepytaj tablicę przez zapętlenie lub cokolwiek zechcesz, aby utworzyć podzbiór głównych wyników fetchedResults. A teraz możesz użyć pełnego zestawu lub podzbioru, gdy istnieje jakiś warunek.

Bardzo podobało mi się podejście @ Josh O ' Connor, gdzie nie używa UISearchController. Ten kontroler nadal (Xcode 9) ma błąd układu, który wielu próbuje obejść.

Powróciłem do używania UISearchBar zamiast UITextField i działa całkiem nieźle. Moim wymogiem dla wyszukiwania / filtra jest wyprodukowanie NSPredicate. To jest przekazywane do FRC:

   class ViewController: UIViewController, UITableViewDelegate, 
 UITableViewDataSource, UISearchBarDelegate {

        @IBOutlet var searchBar: UISearchBar!

         func searchBar(_ searchBar: UISearchBar, textDidChange searchText: String) {

                shouldShowSearchResults = true

                if let queryString = searchBar.text {
                    filterList(queryString)

                    fetchData()
                }
            }



          func filterList(_ queryString: String) {
        if (queryString == "") {
            searchPredicate = nil
    }
        else {
            let brandPredicate = NSPredicate(format: "brand CONTAINS[c] %@", queryString)
            let modelPredicate = NSPredicate(format: "model CONTAINS[c] %@", queryString)
            let orPredicate = NSCompoundPredicate(type: .or, subpredicates: [brandPredicate, modelPredicate])
            searchPredicate = orPredicate
    }

}

...

let context = (UIApplication.shared.delegate as! AppDelegate).persistentContainer.viewContext
        let request = NSFetchRequest<NSFetchRequestResult>(entityName: filmEntity)
        request.returnsDistinctResults = true
        request.propertiesToFetch = ["brand", "model"]

        request.sortDescriptors = [sortDescriptor]
        request.predicate = searchPredicate

Proste podejście do filtrowania istniejącego UITableView za pomocą CoreData i który jest już posortowany tak, jak chcesz.

To dosłownie zbyt mnie 5 minut, aby ustawić i zacząć działać.

Miałem istniejącą UITableView używającą CoreData wypełnioną danymi z iCloud i która ma dość skomplikowane interakcje z użytkownikami i nie chciałem powielać tego wszystkiego dla UISearchViewController. Udało mi się po prostu dodać predykat do istniejącego FetchRequest już używanego przez FetchResultsController i który filtruje już posortowane dane.

-(void)searchBar:(UISearchBar *)searchBar textDidChange:(NSString *)searchText
{
    NSPredicate *filterPredicate;

    if(searchText != nil && searchText.length > 0)
        filterPredicate = [NSPredicate predicateWithFormat:@"(someField CONTAINS[cd] %@) OR (someOtherField CONTAINS[cd] %@)", searchText, searchText];
    else
        filterPredicate = nil;

    _fetchedResultsController.fetchRequest.predicate = filterPredicate;

    NSError *error = nil;
    [_fetchedResultsController performFetch:&error];
    [self.tableView reloadData];
}